Skip to content

Commit e884b68

Browse files
committed
1 parent bb2a8a6 commit e884b68

16 files changed

+30
-23
lines changed

docs/dev/generated/skbio.alignment.TabularMSA.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -772,8 +772,8 @@ <h1>skbio.alignment.TabularMSA<a class="headerlink" href="#skbio-alignment-tabul
772772
<dt><a class="reference internal" href="skbio.sequence.DNA.html#skbio.sequence.DNA" title="skbio.sequence.DNA"><code class="xref py py-obj docutils literal notranslate"><span class="pre">skbio.sequence.DNA</span></code></a></dt><dd></dd>
773773
<dt><a class="reference internal" href="skbio.sequence.RNA.html#skbio.sequence.RNA" title="skbio.sequence.RNA"><code class="xref py py-obj docutils literal notranslate"><span class="pre">skbio.sequence.RNA</span></code></a></dt><dd></dd>
774774
<dt><a class="reference internal" href="skbio.sequence.Protein.html#skbio.sequence.Protein" title="skbio.sequence.Protein"><code class="xref py py-obj docutils literal notranslate"><span class="pre">skbio.sequence.Protein</span></code></a></dt><dd></dd>
775-
<dt><a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.DataFrame</span></code></a></dt><dd></dd>
776-
<dt><a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Index.html#pandas.Index" title="(in pandas v2.2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.Index</span></code></a></dt><dd></dd>
775+
<dt><a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.DataFrame</span></code></a></dt><dd></dd>
776+
<dt><a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Index.html#pandas.Index" title="(in pandas v2.2.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.Index</span></code></a></dt><dd></dd>
777777
<dt><a class="reference internal" href="skbio.alignment.TabularMSA.reassign_index.html#skbio.alignment.TabularMSA.reassign_index" title="skbio.alignment.TabularMSA.reassign_index"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reassign_index</span></code></a></dt><dd></dd>
778778
</dl>
779779
</div>

docs/dev/generated/skbio.alignment.TabularMSA.sort.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -738,7 +738,7 @@ <h1>skbio.alignment.TabularMSA.sort<a class="headerlink" href="#skbio-alignment-
738738
<dl class="simple">
739739
<dt><a class="reference internal" href="skbio.alignment.TabularMSA.html#skbio.alignment.TabularMSA.index" title="skbio.alignment.TabularMSA.index"><code class="xref py py-obj docutils literal notranslate"><span class="pre">index</span></code></a></dt><dd></dd>
740740
<dt><a class="reference internal" href="skbio.alignment.TabularMSA.reassign_index.html#skbio.alignment.TabularMSA.reassign_index" title="skbio.alignment.TabularMSA.reassign_index"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reassign_index</span></code></a></dt><dd></dd>
741-
<dt><a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Series.sort_index.html#pandas.Series.sort_index" title="(in pandas v2.2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.Series.sort_index</span></code></a></dt><dd></dd>
741+
<dt><a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Series.sort_index.html#pandas.Series.sort_index" title="(in pandas v2.2.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.Series.sort_index</span></code></a></dt><dd></dd>
742742
</dl>
743743
</div>
744744
<p class="rubric">Notes</p>

docs/dev/generated/skbio.diversity.alpha.lladser_ci.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -740,7 +740,7 @@
740740
<h1>skbio.diversity.alpha.lladser_ci<a class="headerlink" href="#skbio-diversity-alpha-lladser-ci" title="Link to this heading">#</a></h1>
741741
<dl class="py function">
742742
<dt class="sig sig-object py" id="skbio.diversity.alpha.lladser_ci">
743-
<span class="sig-prename descclassname"><span class="pre">skbio.diversity.alpha.</span></span><span class="sig-name descname"><span class="pre">lladser_ci</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">counts</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">r</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.95</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ci_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ULCL'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/diversity/alpha/_lladser.py#L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.diversity.alpha.lladser_ci" title="Link to this definition">#</a></dt>
743+
<span class="sig-prename descclassname"><span class="pre">skbio.diversity.alpha.</span></span><span class="sig-name descname"><span class="pre">lladser_ci</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">counts</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">r</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.95</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ci_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ULCL'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/diversity/alpha/_lladser.py#L67"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.diversity.alpha.lladser_ci" title="Link to this definition">#</a></dt>
744744
<dd><p>Calculate single CI of the conditional uncovered probability.</p>
745745
<dl class="field-list">
746746
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -758,7 +758,8 @@ <h1>skbio.diversity.alpha.lladser_ci<a class="headerlink" href="#skbio-diversity
758758
conservative upper bound. If <code class="docutils literal notranslate"><span class="pre">'U'</span></code>, upper bound only, lower bound
759759
fixed to 0.0. If <code class="docutils literal notranslate"><span class="pre">'L'</span></code>, lower bound only, upper bound fixed to 1.0.</p>
760760
</dd>
761-
<dt><strong>seed</strong><span class="classifier">int or np.random.Generator, optional</span></dt><dd><p>A user-provided random seed or random generator instance.</p>
761+
<dt><strong>seed</strong><span class="classifier">int, Generator or RandomState, optional</span></dt><dd><p>A user-provided random seed or random generator instance. See
762+
<code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code>.</p>
762763
<div class="versionadded">
763764
<p><span class="versionmodified added">Added in version 0.6.3.</span></p>
764765
</div>

docs/dev/generated/skbio.diversity.alpha.lladser_pe.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -749,7 +749,8 @@ <h1>skbio.diversity.alpha.lladser_pe<a class="headerlink" href="#skbio-diversity
749749
</dd>
750750
<dt><strong>r</strong><span class="classifier">int, optional</span></dt><dd><p>Number of new colors that are required for the next prediction.</p>
751751
</dd>
752-
<dt><strong>seed</strong><span class="classifier">int or np.random.Generator, optional</span></dt><dd><p>A user-provided random seed or random generator instance.</p>
752+
<dt><strong>seed</strong><span class="classifier">int, Generator or RandomState, optional</span></dt><dd><p>A user-provided random seed or random generator instance. See
753+
<code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code>.</p>
753754
<div class="versionadded">
754755
<p><span class="versionmodified added">Added in version 0.6.3.</span></p>
755756
</div>

docs/dev/generated/skbio.stats.composition.dirmult_lme.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -772,8 +772,8 @@ <h1>skbio.stats.composition.dirmult_lme<a class="headerlink" href="#skbio-stats-
772772
<a class="reference external" href="https://www.statsmodels.org/stable/generated/statsmodels.stats.multitest.multipletests.html#statsmodels.stats.multitest.multipletests" title="(in statsmodels 0.14.3 v0.14.3)"><code class="xref py py-func docutils literal notranslate"><span class="pre">multipletests</span></code></a> function.
773773
Case-insensitive. If None, no correction will be performed.</p>
774774
</dd>
775-
<dt><strong>seed</strong><span class="classifier">int or np.random.Generator, optional</span></dt><dd><p>A user-provided random seed or random generator instance for drawing from the
776-
Dirichlet distribution.</p>
775+
<dt><strong>seed</strong><span class="classifier">int, Generator or RandomState, optional</span></dt><dd><p>A user-provided random seed or random generator instance for drawing from the
776+
Dirichlet distribution. See <code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code>.</p>
777777
</dd>
778778
<dt><strong>re_formula</strong><span class="classifier">str, optional</span></dt><dd><p>Random coefficient formula. See <a class="reference external" href="https://www.statsmodels.org/stable/generated/statsmodels.regression.mixed_linear_model.MixedLM.from_formula.html#statsmodels.regression.mixed_linear_model.MixedLM.from_formula" title="(in statsmodels 0.14.3 v0.14.3)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">MixedLM.from_formula</span></code></a>.</p>
779779
</dd>

docs/dev/generated/skbio.stats.composition.dirmult_ttest.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -768,8 +768,8 @@ <h1>skbio.stats.composition.dirmult_ttest<a class="headerlink" href="#skbio-stat
768768
<a class="reference external" href="https://www.statsmodels.org/stable/generated/statsmodels.stats.multitest.multipletests.html#statsmodels.stats.multitest.multipletests" title="(in statsmodels 0.14.3 v0.14.3)"><code class="xref py py-func docutils literal notranslate"><span class="pre">multipletests</span></code></a> function.
769769
Case-insensitive. If None, no correction will be performed.</p>
770770
</dd>
771-
<dt><strong>seed</strong><span class="classifier">int or np.random.Generator, optional</span></dt><dd><p>A user-provided random seed or random generator instance for drawing from the
772-
Dirichlet distribution.</p>
771+
<dt><strong>seed</strong><span class="classifier">int, Generator or RandomState, optional</span></dt><dd><p>A user-provided random seed or random generator instance for drawing from the
772+
Dirichlet distribution. See <code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code>.</p>
773773
</dd>
774774
</dl>
775775
</dd>

docs/dev/generated/skbio.stats.isubsample.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -726,7 +726,8 @@ <h1>skbio.stats.isubsample<a class="headerlink" href="#skbio-stats-isubsample" t
726726
return a hashable value indicating the bin that that entry should be
727727
placed in.</p>
728728
</dd>
729-
<dt><strong>seed</strong><span class="classifier">int or np.random.Generator, optional</span></dt><dd><p>A user-provided random seed or random generator instance.</p>
729+
<dt><strong>seed</strong><span class="classifier">int, Generator or RandomState, optional</span></dt><dd><p>A user-provided random seed or random generator instance. See
730+
<code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code>.</p>
730731
<div class="versionadded">
731732
<p><span class="versionmodified added">Added in version 0.6.3.</span></p>
732733
</div>

docs/dev/generated/skbio.stats.power.confidence_bound.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@
707707
<h1>skbio.stats.power.confidence_bound<a class="headerlink" href="#skbio-stats-power-confidence-bound" title="Link to this heading">#</a></h1>
708708
<dl class="py function">
709709
<dt class="sig sig-object py" id="skbio.stats.power.confidence_bound">
710-
<span class="sig-prename descclassname"><span class="pre">skbio.stats.power.</span></span><span class="sig-name descname"><span class="pre">confidence_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">df</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">axis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/stats/power.py#L574"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.stats.power.confidence_bound" title="Link to this definition">#</a></dt>
710+
<span class="sig-prename descclassname"><span class="pre">skbio.stats.power.</span></span><span class="sig-name descname"><span class="pre">confidence_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">df</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">axis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/stats/power.py#L576"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.stats.power.confidence_bound" title="Link to this definition">#</a></dt>
711711
<dd><p>Calculate a confidence bound assuming a normal distribution.</p>
712712
<dl class="field-list simple">
713713
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

docs/dev/generated/skbio.stats.power.paired_subsamples.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@
707707
<h1>skbio.stats.power.paired_subsamples<a class="headerlink" href="#skbio-stats-power-paired-subsamples" title="Link to this heading">#</a></h1>
708708
<dl class="py function">
709709
<dt class="sig sig-object py" id="skbio.stats.power.paired_subsamples">
710-
<span class="sig-prename descclassname"><span class="pre">skbio.stats.power.</span></span><span class="sig-name descname"><span class="pre">paired_subsamples</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">meta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cat</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">control_cats</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict_match</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/stats/power.py#L626"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.stats.power.paired_subsamples" title="Link to this definition">#</a></dt>
710+
<span class="sig-prename descclassname"><span class="pre">skbio.stats.power.</span></span><span class="sig-name descname"><span class="pre">paired_subsamples</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">meta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cat</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">control_cats</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict_match</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/stats/power.py#L628"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.stats.power.paired_subsamples" title="Link to this definition">#</a></dt>
711711
<dd><p>Draw a list of samples varied by <cite>cat</cite> and matched for <cite>control_cats</cite>.</p>
712712
<p>This function is designed to provide controlled samples, based on a
713713
metadata category. For example, one could control for age, sex, education
@@ -735,7 +735,8 @@ <h1>skbio.stats.power.paired_subsamples<a class="headerlink" href="#skbio-stats-
735735
False, missing values (NaN) in the <cite>control_cats</cite> can be considered
736736
matches.</p>
737737
</dd>
738-
<dt><strong>seed</strong><span class="classifier">int or np.random.Generator, optional</span></dt><dd><p>A user-provided random seed or random generator instance.</p>
738+
<dt><strong>seed</strong><span class="classifier">int, Generator or RandomState, optional</span></dt><dd><p>A user-provided random seed or random generator instance. See
739+
<code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code>.</p>
739740
<div class="versionadded">
740741
<p><span class="versionmodified added">Added in version 0.6.3.</span></p>
741742
</div>

0 commit comments

Comments
 (0)