Adding python library docs

parent b79294eb
"""A pypi demonstration vehicle.
.. moduleauthor:: Andrew Carter <andrew@invalid.com>
"""
from .parametric_tests import *
from .nonparametric_tests import *
from scipy.stats import ttest_ind, ttest_rel, wilcoxon, mannwhitneyu
__all__ = ['anova_test',
'bonferroni_test',
......@@ -18,4 +25,8 @@ __all__ = ['anova_test',
'holm_multitest',
'hochberg_multitest',
'finner_multitest',
'shaffer_multitest']
'shaffer_multitest',
'ttest_ind',
'ttest_rel',
'wilcoxon',
'mannwhitneyu',]
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 4f101a1b0e8472aa45d3aaf897ff7988
tags: 645f666f9bcd5a90fca523b33c5a78b7
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Overview: module code &mdash; STAC 0.7 documentation</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="top" title="STAC 0.7 documentation" href="../index.html"/>
<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="../index.html" class="fa fa-home"> STAC</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../scipy-stats.html">Tests for two groups comparison</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../scipy.stats.ttest_ind.html">scipy.stats.ttest_ind</a></li>
<li class="toctree-l2"><a class="reference internal" href="../scipy.stats.ttest_rel.html">scipy.stats.ttest_rel</a></li>
<li class="toctree-l2"><a class="reference internal" href="../scipy.stats.wilcoxon.html">scipy.stats.wilcoxon</a></li>
<li class="toctree-l2"><a class="reference internal" href="../scipy.stats.mannwhitneyu.html">scipy.stats.mannwhitneyu</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../parametric.html">Parametric tests for Multiple Comparison</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../stac.parametric_tests.anova_test.html">stac.parametric_tests.anova_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.parametric_tests.anova_within_test.html">stac.parametric_tests.anova_within_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.parametric_tests.bonferroni_test.html">stac.parametric_tests.bonferroni_test</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nonparametric.html">Non-parametric tests for Multiple Comparison</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.friedman_test.html">stac.nonparametric_tests.friedman_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.friedman_aligned_ranks_test.html">stac.nonparametric_tests.friedman_aligned_ranks_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.quade_test.html">stac.nonparametric_tests.quade_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.holm_test.html">stac.nonparametric_tests.holm_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.finner_test.html">stac.nonparametric_tests.finner_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.hochberg_test.html">stac.nonparametric_tests.hochberg_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.li_test.html">stac.nonparametric_tests.li_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.nemenyi_multitest.html">stac.nonparametric_tests.nemenyi_multitest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.holm_multitest.html">stac.nonparametric_tests.holm_multitest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.finner_multitest.html">stac.nonparametric_tests.finner_multitest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.hochberg_multitest.html">stac.nonparametric_tests.hochberg_multitest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.shaffer_multitest.html">stac.nonparametric_tests.shaffer_multitest</a></li>
</ul>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">STAC</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> &raquo;</li>
<li>Overview: module code</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document">
<h1>All modules for which code is available</h1>
<ul><li><a href="scipy/stats.html">scipy.stats</a></li>
<li><a href="stac.html">stac</a></li>
<ul><li><a href="stac/nonparametric_tests.html">stac.nonparametric_tests</a></li>
<li><a href="stac/parametric_tests.html">stac.parametric_tests</a></li>
</ul></ul>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2015, Ismael.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
\ No newline at end of file
This diff is collapsed.
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>stac &mdash; STAC 0.7 documentation</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="top" title="STAC 0.7 documentation" href="../index.html"/>
<link rel="up" title="Module code" href="index.html"/>
<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="../index.html" class="fa fa-home"> STAC</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../scipy-stats.html">Tests for two groups comparison</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../scipy.stats.ttest_ind.html">scipy.stats.ttest_ind</a></li>
<li class="toctree-l2"><a class="reference internal" href="../scipy.stats.ttest_rel.html">scipy.stats.ttest_rel</a></li>
<li class="toctree-l2"><a class="reference internal" href="../scipy.stats.wilcoxon.html">scipy.stats.wilcoxon</a></li>
<li class="toctree-l2"><a class="reference internal" href="../scipy.stats.mannwhitneyu.html">scipy.stats.mannwhitneyu</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../parametric.html">Parametric tests for Multiple Comparison</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../stac.parametric_tests.anova_test.html">stac.parametric_tests.anova_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.parametric_tests.anova_within_test.html">stac.parametric_tests.anova_within_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.parametric_tests.bonferroni_test.html">stac.parametric_tests.bonferroni_test</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nonparametric.html">Non-parametric tests for Multiple Comparison</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.friedman_test.html">stac.nonparametric_tests.friedman_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.friedman_aligned_ranks_test.html">stac.nonparametric_tests.friedman_aligned_ranks_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.quade_test.html">stac.nonparametric_tests.quade_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.holm_test.html">stac.nonparametric_tests.holm_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.finner_test.html">stac.nonparametric_tests.finner_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.hochberg_test.html">stac.nonparametric_tests.hochberg_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.li_test.html">stac.nonparametric_tests.li_test</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.nemenyi_multitest.html">stac.nonparametric_tests.nemenyi_multitest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.holm_multitest.html">stac.nonparametric_tests.holm_multitest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.finner_multitest.html">stac.nonparametric_tests.finner_multitest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.hochberg_multitest.html">stac.nonparametric_tests.hochberg_multitest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stac.nonparametric_tests.shaffer_multitest.html">stac.nonparametric_tests.shaffer_multitest</a></li>
</ul>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">STAC</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="index.html">Module code</a> &raquo;</li>
<li>stac</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document">
<h1>Source code for stac</h1><div class="highlight"><pre>
<span class="sd">&quot;&quot;&quot;A pypi demonstration vehicle.</span>
<span class="sd">.. moduleauthor:: Andrew Carter &lt;andrew@invalid.com&gt;</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">.parametric_tests</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">.nonparametric_tests</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">scipy.stats</span> <span class="kn">import</span> <span class="n">ttest_ind</span><span class="p">,</span> <span class="n">ttest_rel</span><span class="p">,</span> <span class="n">wilcoxon</span><span class="p">,</span> <span class="n">mannwhitneyu</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;anova_test&#39;</span><span class="p">,</span>
<span class="s">&#39;bonferroni_test&#39;</span><span class="p">,</span>
<span class="s">&#39;wilcoxon_test&#39;</span><span class="p">,</span>
<span class="s">&#39;test_ranking&#39;</span><span class="p">,</span>
<span class="s">&#39;friedman_test&#39;</span><span class="p">,</span>
<span class="s">&#39;iman_davenport_test&#39;</span><span class="p">,</span>
<span class="s">&#39;friedman_rangos_alineados_test&#39;</span><span class="p">,</span>
<span class="s">&#39;quade_test&#39;</span><span class="p">,</span>
<span class="s">&#39;bonferroni_dunn_test&#39;</span><span class="p">,</span>
<span class="s">&#39;holm_test&#39;</span><span class="p">,</span>
<span class="s">&#39;hochberg_test&#39;</span><span class="p">,</span>
<span class="s">&#39;li_test&#39;</span><span class="p">,</span>
<span class="s">&#39;finner_test&#39;</span><span class="p">,</span>
<span class="s">&#39;nemenyi_multitest&#39;</span><span class="p">,</span>
<span class="s">&#39;holm_multitest&#39;</span><span class="p">,</span>
<span class="s">&#39;hochberg_multitest&#39;</span><span class="p">,</span>
<span class="s">&#39;finner_multitest&#39;</span><span class="p">,</span>
<span class="s">&#39;shaffer_multitest&#39;</span><span class="p">]</span>
</pre></div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2015, Ismael.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
\ No newline at end of file
This diff is collapsed.
This diff is collapsed.
.. STAC documentation master file, created by
sphinx-quickstart on Thu Jan 29 13:09:17 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to STAC's documentation!
================================
Contents:
--------------
.. toctree::
scipy-stats.rst
parametric.rst
nonparametric.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
Non-parametric tests for Multiple Comparison
********************************************
.. currentmodule:: stac.nonparametric_tests
.. rubric:: Ranking tests
.. autosummary::
:toctree:
friedman_test
friedman_aligned_ranks_test
quade_test
.. rubric:: Post-hoc 1 vs all tests
.. autosummary::
:toctree:
bonferroni_test
holm_test
finner_test
hochberg_test
li_test
.. rubric:: Post-hoc all vs all tests
.. autosummary::
:toctree:
nemenyi_multitest
holm_multitest
finner_multitest
hochberg_multitest
shaffer_multitest
Parametric tests for Multiple Comparison
****************************************
.. currentmodule:: stac.parametric_tests
.. rubric:: ANOVA tests
.. autosummary::
:toctree:
anova_test
anova_within_test
.. rubric:: Post-hoc tests
.. autosummary::
:toctree:
bonferroni_test
Tests for two groups comparison
===============
.. currentmodule:: scipy.stats
.. autosummary::
:toctree:
ttest_ind
ttest_rel
wilcoxon
mannwhitneyu
scipy.stats.mannwhitneyu
========================
.. currentmodule:: scipy.stats
.. autofunction:: mannwhitneyu
\ No newline at end of file
scipy.stats.ttest_ind
=====================
.. currentmodule:: scipy.stats
.. autofunction:: ttest_ind
\ No newline at end of file
scipy.stats.ttest_rel
=====================
.. currentmodule:: scipy.stats
.. autofunction:: ttest_rel
\ No newline at end of file
scipy.stats.wilcoxon
====================
.. currentmodule:: scipy.stats
.. autofunction:: wilcoxon
\ No newline at end of file
stac.nonparametric_tests.finner_multitest
=========================================
.. currentmodule:: stac.nonparametric_tests
.. autofunction:: finner_multitest
\ No newline at end of file
stac.nonparametric_tests.finner_test
====================================
.. currentmodule:: stac.nonparametric_tests
.. autofunction:: finner_test
\ No newline at end of file
stac.nonparametric_tests.friedman_aligned_ranks_test
====================================================