statisticsTest_documentation.html 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. <!DOCTYPE html>
  2. <html class="writer-html5" lang="fr" >
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>Avalaible statistics test &mdash; Documentation statisticsTest 0.0.1</title>
  7. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  8. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  9. <!--[if lt IE 9]>
  10. <script src="_static/js/html5shiv.min.js"></script>
  11. <![endif]-->
  12. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  13. <script src="_static/jquery.js"></script>
  14. <script src="_static/underscore.js"></script>
  15. <script src="_static/doctools.js"></script>
  16. <script src="_static/translations.js"></script>
  17. <script type="text/javascript" src="_static/js/theme.js"></script>
  18. <link rel="index" title="Index" href="genindex.html" />
  19. <link rel="search" title="Recherche" href="search.html" />
  20. <link rel="prev" title="Getting started" href="getting_started.html" />
  21. </head>
  22. <body class="wy-body-for-nav">
  23. <div class="wy-grid-for-nav">
  24. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  25. <div class="wy-side-scroll">
  26. <div class="wy-side-nav-search" >
  27. <a href="index.html" class="icon icon-home"> statisticsTest
  28. </a>
  29. <div role="search">
  30. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  31. <input type="text" name="q" placeholder="Rechercher docs" />
  32. <input type="hidden" name="check_keywords" value="yes" />
  33. <input type="hidden" name="area" value="default" />
  34. </form>
  35. </div>
  36. </div>
  37. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  38. <ul class="current">
  39. <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
  40. <li class="toctree-l1 current"><a class="current reference internal" href="#">Avalaible statistics test</a></li>
  41. </ul>
  42. </div>
  43. </div>
  44. </nav>
  45. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  46. <nav class="wy-nav-top" aria-label="top navigation">
  47. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  48. <a href="index.html">statisticsTest</a>
  49. </nav>
  50. <div class="wy-nav-content">
  51. <div class="rst-content">
  52. <div role="navigation" aria-label="breadcrumbs navigation">
  53. <ul class="wy-breadcrumbs">
  54. <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
  55. <li>Avalaible statistics test</li>
  56. <li class="wy-breadcrumbs-aside">
  57. <a href="_sources/statisticsTest_documentation.rst.txt" rel="nofollow"> Afficher la source de la page</a>
  58. </li>
  59. </ul>
  60. <hr/>
  61. </div>
  62. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  63. <div itemprop="articleBody">
  64. <div class="section" id="module-statisticsTest">
  65. <span id="avalaible-statistics-test"></span><h1>Avalaible statistics test<a class="headerlink" href="#module-statisticsTest" title="Lien permanent vers ce titre">¶</a></h1>
  66. <dl class="py function">
  67. <dt id="statisticsTest.chisquare_trend_contingency">
  68. <code class="sig-prename descclassname">statisticsTest.</code><code class="sig-name descname">chisquare_trend_contingency</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">observed</span></em>, <em class="sig-param"><span class="n">tendencies_values</span></em>, <em class="sig-param"><span class="n">axis</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#statisticsTest.chisquare_trend_contingency" title="Lien permanent vers cette définition">¶</a></dt>
  69. <dd><p>Apply a Chi2 square Cochran-Armitage trend test with variable in a contingency table.
  70. It measure the effect of an tendencie variable on a evaluated variable.
  71. The evaluated variable should be a categorial variable with 2 modalities. It should be of shape 2.
  72. The tendencies values should be of shape &gt;= 2 an be numeric.</p>
  73. <blockquote>
  74. <div><ul class="simple">
  75. <li><p>Monotonous evolution of the tendencie (not checked by the function)</p></li>
  76. <li><p>Theorical value &gt;= 5 : checked by the function</p></li>
  77. </ul>
  78. </div></blockquote>
  79. <blockquote>
  80. <div><p>observed, numpy matrix : contingency table of observed value. Should have an axis with a shape of 2 as the test is designed to evaluate tendencies on 2 modalities categorial variable. If only an axis is of shape 2, this axis is used for applying the test, otherwise you should specify the axis containing the tested variable with the axis parameter.
  81. tendencies_values, numpy vector : values of the tendencie variable, should be an 1D vector of shape &gt;= 2</p>
  82. </div></blockquote>
  83. <dl>
  84. <dt>chi2<span class="classifier">float</span></dt><dd><p>The test statistic.</p>
  85. </dd>
  86. <dt>p<span class="classifier">float</span></dt><dd><p>The p-value of the test</p>
  87. </dd>
  88. <dt>dof<span class="classifier">int</span></dt><dd><p>Degrees of freedom</p>
  89. </dd>
  90. <dt>expected<span class="classifier">ndarray, same shape as <cite>observed</cite></span></dt><dd><p>The expected frequencies, based on the marginal sums of the table.</p>
  91. </dd>
  92. </dl>
  93. </dd></dl>
  94. </div>
  95. </div>
  96. </div>
  97. <footer>
  98. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  99. <a href="getting_started.html" class="btn btn-neutral float-left" title="Getting started" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Précédent</a>
  100. </div>
  101. <hr/>
  102. <div role="contentinfo">
  103. <p>
  104. &#169; Copyright 2021, Ali BELLAMINE.
  105. </p>
  106. </div>
  107. Compilé avec <a href="https://www.sphinx-doc.org/">Sphinx</a> en utilisant un
  108. <a href="https://github.com/readthedocs/sphinx_rtd_theme">thème</a>
  109. fourni par <a href="https://readthedocs.org">Read the Docs</a>.
  110. </footer>
  111. </div>
  112. </div>
  113. </section>
  114. </div>
  115. <script type="text/javascript">
  116. jQuery(function () {
  117. SphinxRtdTheme.Navigation.enable(true);
  118. });
  119. </script>
  120. </body>
  121. </html>