Reduced submodules to show

benford/benford.py

@@ -438,7 +438,7 @@ def update_confidence(self, new_conf, tests=None):
 
     @property
     def all_confidences(self):
-        """dict: a dictionary the confidence level for the instance's tests,
+        """dict: a dictionary with a confidence level for each computed tests,
         when applicable."""
         con_dic= {}
         for key in self.tests:

docs/build/html/_modules/benford/expected.html

@@ -147,7 +147,7 @@ <h1>Source code for benford.expected</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">.viz</span> <span class="kn">import</span> <span class="n">plot_expected</span>
 
 
-<div class="viewcode-block" id="First"><a class="viewcode-back" href="../../benford.html#benford.expected.First">[docs]</a><span class="k">class</span> <span class="nc">First</span><span class="p">(</span><span class="n">DataFrame</span><span class="p">):</span>
+<div class="viewcode-block" id="First"><a class="viewcode-back" href="../../api.html#benford.expected.First">[docs]</a><span class="k">class</span> <span class="nc">First</span><span class="p">(</span><span class="n">DataFrame</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Holds the expected probabilities of the First, First Two, or</span>
 <span class="sd">    First Three digits according to Benford&#39;s distribution.</span>
 
@@ -172,7 +172,7 @@ <h1>Source code for benford.expected</h1><div class="highlight"><pre>
             <span class="n">plot_expected</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">digs</span><span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="Second"><a class="viewcode-back" href="../../benford.html#benford.expected.Second">[docs]</a><span class="k">class</span> <span class="nc">Second</span><span class="p">(</span><span class="n">DataFrame</span><span class="p">):</span>
+<div class="viewcode-block" id="Second"><a class="viewcode-back" href="../../api.html#benford.expected.Second">[docs]</a><span class="k">class</span> <span class="nc">Second</span><span class="p">(</span><span class="n">DataFrame</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Holds the expected probabilities of the Second Digits</span>
 <span class="sd">    according to Benford&#39;s distribution.</span>
 
@@ -193,7 +193,7 @@ <h1>Source code for benford.expected</h1><div class="highlight"><pre>
             <span class="n">plot_expected</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="mi">22</span><span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="LastTwo"><a class="viewcode-back" href="../../benford.html#benford.expected.LastTwo">[docs]</a><span class="k">class</span> <span class="nc">LastTwo</span><span class="p">(</span><span class="n">DataFrame</span><span class="p">):</span>
+<div class="viewcode-block" id="LastTwo"><a class="viewcode-back" href="../../api.html#benford.expected.LastTwo">[docs]</a><span class="k">class</span> <span class="nc">LastTwo</span><span class="p">(</span><span class="n">DataFrame</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Holds the expected probabilities of the Last Two Digits</span>
 <span class="sd">    according to Benford&#39;s distribution.</span>
 

docs/build/html/_modules/benford/stats.html

@@ -145,7 +145,7 @@ <h1>Source code for benford.stats</h1><div class="highlight"><pre>
 <span class="c1"># from .constants import digs_dict, confs, crit_chi2, KS_crit, mad_dict</span>
 
 
-<div class="viewcode-block" id="Z_score"><a class="viewcode-back" href="../../benford.html#benford.stats.Z_score">[docs]</a><span class="k">def</span> <span class="nf">Z_score</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="n">N</span><span class="p">):</span>
+<div class="viewcode-block" id="Z_score"><a class="viewcode-back" href="../../api.html#benford.stats.Z_score">[docs]</a><span class="k">def</span> <span class="nf">Z_score</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="n">N</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Computes the Z statistics for the proportions studied</span>
 
 <span class="sd">    Args:</span>
@@ -160,7 +160,7 @@ <h1>Source code for benford.stats</h1><div class="highlight"><pre>
            <span class="p">(</span><span class="n">frame</span><span class="o">.</span><span class="n">Expected</span> <span class="o">*</span> <span class="p">(</span><span class="mf">1.</span> <span class="o">-</span> <span class="n">frame</span><span class="o">.</span><span class="n">Expected</span><span class="p">))</span> <span class="o">/</span> <span class="n">N</span><span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="chi_square"><a class="viewcode-back" href="../../benford.html#benford.stats.chi_square">[docs]</a><span class="k">def</span> <span class="nf">chi_square</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="n">ddf</span><span class="p">,</span> <span class="n">confidence</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+<div class="viewcode-block" id="chi_square"><a class="viewcode-back" href="../../api.html#benford.stats.chi_square">[docs]</a><span class="k">def</span> <span class="nf">chi_square</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="n">ddf</span><span class="p">,</span> <span class="n">confidence</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Comnputes the chi-square statistic of the found distributions and compares</span>
 <span class="sd">    it with the critical chi-square of such a sample, according to the</span>
 <span class="sd">    confidence level chosen and the degrees of freedom - len(sample) -1.</span>
@@ -191,7 +191,7 @@ <h1>Source code for benford.stats</h1><div class="highlight"><pre>
         <span class="k">return</span> <span class="p">(</span><span class="n">found_chi</span><span class="p">,</span> <span class="n">crit_chi</span><span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="chi_square_2"><a class="viewcode-back" href="../../benford.html#benford.stats.chi_square_2">[docs]</a><span class="k">def</span> <span class="nf">chi_square_2</span><span class="p">(</span><span class="n">frame</span><span class="p">):</span>
+<div class="viewcode-block" id="chi_square_2"><a class="viewcode-back" href="../../api.html#benford.stats.chi_square_2">[docs]</a><span class="k">def</span> <span class="nf">chi_square_2</span><span class="p">(</span><span class="n">frame</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Computes the chi-square statistic of the found distributions</span>
 
 <span class="sd">    Args:</span>
@@ -205,7 +205,7 @@ <h1>Source code for benford.stats</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="p">(</span><span class="n">dif_counts</span> <span class="o">**</span> <span class="mi">2</span> <span class="o">/</span> <span class="n">exp_counts</span><span class="p">)</span><span class="o">.</span><span class="n">sum</span><span class="p">()</span></div>
 
 
-<div class="viewcode-block" id="KS"><a class="viewcode-back" href="../../benford.html#benford.stats.KS">[docs]</a><span class="k">def</span> <span class="nf">KS</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="n">confidence</span><span class="p">,</span> <span class="n">N</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+<div class="viewcode-block" id="KS"><a class="viewcode-back" href="../../api.html#benford.stats.KS">[docs]</a><span class="k">def</span> <span class="nf">KS</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="n">confidence</span><span class="p">,</span> <span class="n">N</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Computes the Kolmogorov-Smirnov test of the found distributions</span>
 <span class="sd">    and compares it with the critical chi-square of such a sample,</span>
 <span class="sd">    according to the confidence level chosen.</span>
@@ -239,7 +239,7 @@ <h1>Source code for benford.stats</h1><div class="highlight"><pre>
         <span class="k">return</span> <span class="p">(</span><span class="n">suprem</span><span class="p">,</span> <span class="n">crit_KS</span><span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="KS_2"><a class="viewcode-back" href="../../benford.html#benford.stats.KS_2">[docs]</a><span class="k">def</span> <span class="nf">KS_2</span><span class="p">(</span><span class="n">frame</span><span class="p">):</span>
+<div class="viewcode-block" id="KS_2"><a class="viewcode-back" href="../../api.html#benford.stats.KS_2">[docs]</a><span class="k">def</span> <span class="nf">KS_2</span><span class="p">(</span><span class="n">frame</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Computes the Kolmogorov-Smirnov test of the found distributions</span>
 <span class="sd">    </span>
 <span class="sd">    Args:</span>
@@ -255,7 +255,7 @@ <h1>Source code for benford.stats</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="p">((</span><span class="n">ks_frame</span><span class="o">.</span><span class="n">Found</span> <span class="o">-</span> <span class="n">ks_frame</span><span class="o">.</span><span class="n">Expected</span><span class="p">)</span><span class="o">.</span><span class="n">abs</span><span class="p">())</span><span class="o">.</span><span class="n">max</span><span class="p">()</span></div>
 
 
-<div class="viewcode-block" id="mad"><a class="viewcode-back" href="../../benford.html#benford.stats.mad">[docs]</a><span class="k">def</span> <span class="nf">mad</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="n">test</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+<div class="viewcode-block" id="mad"><a class="viewcode-back" href="../../api.html#benford.stats.mad">[docs]</a><span class="k">def</span> <span class="nf">mad</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="n">test</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Computes the Mean Absolute Deviation (MAD) between the found and the</span>
 <span class="sd">    expected proportions.</span>
 
@@ -285,7 +285,7 @@ <h1>Source code for benford.stats</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">mad</span></div>
 
 
-<div class="viewcode-block" id="mse"><a class="viewcode-back" href="../../benford.html#benford.stats.mse">[docs]</a><span class="k">def</span> <span class="nf">mse</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+<div class="viewcode-block" id="mse"><a class="viewcode-back" href="../../api.html#benford.stats.mse">[docs]</a><span class="k">def</span> <span class="nf">mse</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Computes the test&#39;s Mean Square Error</span>
 
 <span class="sd">    Args:</span>

docs/build/html/_modules/benford/viz.html

@@ -147,7 +147,7 @@ <h1>Source code for benford.viz</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">.constants</span> <span class="kn">import</span> <span class="n">colors</span>
 
 
-<div class="viewcode-block" id="plot_expected"><a class="viewcode-back" href="../../benford.html#benford.viz.plot_expected">[docs]</a><span class="k">def</span> <span class="nf">plot_expected</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">digs</span><span class="p">):</span>
+<div class="viewcode-block" id="plot_expected"><a class="viewcode-back" href="../../api.html#benford.viz.plot_expected">[docs]</a><span class="k">def</span> <span class="nf">plot_expected</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">digs</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Plots the Expected Benford Distributions</span>
 
 <span class="sd">    Args:</span>
@@ -194,7 +194,7 @@ <h1>Source code for benford.viz</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">x</span><span class="p">,</span> <span class="n">figsize</span><span class="p">,</span> <span class="n">text_x</span>
 
 
-<div class="viewcode-block" id="plot_digs"><a class="viewcode-back" href="../../benford.html#benford.viz.plot_digs">[docs]</a><span class="k">def</span> <span class="nf">plot_digs</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y_Exp</span><span class="p">,</span> <span class="n">y_Found</span><span class="p">,</span> <span class="n">N</span><span class="p">,</span> <span class="n">figsize</span><span class="p">,</span> <span class="n">conf_Z</span><span class="p">,</span> <span class="n">text_x</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+<div class="viewcode-block" id="plot_digs"><a class="viewcode-back" href="../../api.html#benford.viz.plot_digs">[docs]</a><span class="k">def</span> <span class="nf">plot_digs</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y_Exp</span><span class="p">,</span> <span class="n">y_Found</span><span class="p">,</span> <span class="n">N</span><span class="p">,</span> <span class="n">figsize</span><span class="p">,</span> <span class="n">conf_Z</span><span class="p">,</span> <span class="n">text_x</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Plots the digits tests results</span>
 
 <span class="sd">    Args:</span>
@@ -250,7 +250,7 @@ <h1>Source code for benford.viz</h1><div class="highlight"><pre>
     <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">(</span><span class="n">block</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="plot_sum"><a class="viewcode-back" href="../../benford.html#benford.viz.plot_sum">[docs]</a><span class="k">def</span> <span class="nf">plot_sum</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">figsize</span><span class="p">,</span> <span class="n">li</span><span class="p">,</span> <span class="n">text_x</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+<div class="viewcode-block" id="plot_sum"><a class="viewcode-back" href="../../api.html#benford.viz.plot_sum">[docs]</a><span class="k">def</span> <span class="nf">plot_sum</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">figsize</span><span class="p">,</span> <span class="n">li</span><span class="p">,</span> <span class="n">text_x</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Plots the summation test results</span>
 
 <span class="sd">    Args:</span>
@@ -280,7 +280,7 @@ <h1>Source code for benford.viz</h1><div class="highlight"><pre>
     <span class="n">ax</span><span class="o">.</span><span class="n">legend</span><span class="p">()</span>
     <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">(</span><span class="n">block</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div>
 
-<div class="viewcode-block" id="plot_ordered_mantissas"><a class="viewcode-back" href="../../benford.html#benford.viz.plot_ordered_mantissas">[docs]</a><span class="k">def</span> <span class="nf">plot_ordered_mantissas</span><span class="p">(</span><span class="n">col</span><span class="p">,</span> <span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">12</span><span class="p">,</span> <span class="mi">12</span><span class="p">)):</span>
+<div class="viewcode-block" id="plot_ordered_mantissas"><a class="viewcode-back" href="../../api.html#benford.viz.plot_ordered_mantissas">[docs]</a><span class="k">def</span> <span class="nf">plot_ordered_mantissas</span><span class="p">(</span><span class="n">col</span><span class="p">,</span> <span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">12</span><span class="p">,</span> <span class="mi">12</span><span class="p">)):</span>
     <span class="sd">&quot;&quot;&quot;Plots the ordered mantissas and compares them to the expected, straight</span>
 <span class="sd">        line that should be formed in a Benford-cmpliant set.</span>
 <span class="sd">    </span>
@@ -304,7 +304,7 @@ <h1>Source code for benford.viz</h1><div class="highlight"><pre>
     <span class="n">plt</span><span class="o">.</span><span class="n">legend</span><span class="p">(</span><span class="n">loc</span><span class="o">=</span><span class="s1">&#39;upper left&#39;</span><span class="p">)</span>
     <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">(</span><span class="n">block</span><span class="o">=</span><span class="kc">False</span><span class="p">);</span></div>
 
-<div class="viewcode-block" id="plot_mantissa_arc_test"><a class="viewcode-back" href="../../benford.html#benford.viz.plot_mantissa_arc_test">[docs]</a><span class="k">def</span> <span class="nf">plot_mantissa_arc_test</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">gravity_center</span><span class="p">,</span> <span class="n">grid</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">figsize</span><span class="o">=</span><span class="mi">12</span><span class="p">):</span>
+<div class="viewcode-block" id="plot_mantissa_arc_test"><a class="viewcode-back" href="../../api.html#benford.viz.plot_mantissa_arc_test">[docs]</a><span class="k">def</span> <span class="nf">plot_mantissa_arc_test</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">gravity_center</span><span class="p">,</span> <span class="n">grid</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">figsize</span><span class="o">=</span><span class="mi">12</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Draws thee Mantissa Arc Test after computing X and Y circular coordinates</span>
 <span class="sd">    for every mantissa and the center of gravity for the set</span>
 <span class="sd">    </span>

docs/build/html/_sources/api.rst.txt

@@ -0,0 +1,41 @@
+benford package
+===============
+
+Submodules
+----------
+
+benford.benford module
+----------------------
+
+.. automodule:: benford.benford
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+benford.expected module
+-----------------------
+
+.. automodule:: benford.expected
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+benford.stats module
+--------------------
+
+.. automodule:: benford.stats
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+benford.viz module
+------------------
+
+.. automodule:: benford.viz
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

docs/build/html/_sources/benford.rst.txt

@@ -55,11 +55,6 @@ benford.stats module
 benford.utils module
 --------------------
 
-.. automodule:: benford.utils
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 benford.viz module
 ------------------