Skip to content

Commit 50230f4

Browse files
committed
1 parent f2a8b35 commit 50230f4

32 files changed

+942
-29
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
skbio.util.get\_rng
2+
===================
3+
4+
.. currentmodule:: skbio.util
5+
6+
.. autofunction:: get_rng

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -759,7 +759,7 @@ <h1>skbio.diversity.alpha.lladser_ci<a class="headerlink" href="#skbio-diversity
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>
761761
<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>
762+
<a class="reference internal" href="skbio.util.get_rng.html#skbio.util.get_rng" title="skbio.util.get_rng"><code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code></a>.</p>
763763
<div class="versionadded">
764764
<p><span class="versionmodified added">Added in version 0.6.3.</span></p>
765765
</div>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -750,7 +750,7 @@ <h1>skbio.diversity.alpha.lladser_pe<a class="headerlink" href="#skbio-diversity
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>
752752
<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>
753+
<a class="reference internal" href="skbio.util.get_rng.html#skbio.util.get_rng" title="skbio.util.get_rng"><code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code></a>.</p>
754754
<div class="versionadded">
755755
<p><span class="versionmodified added">Added in version 0.6.3.</span></p>
756756
</div>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -773,7 +773,7 @@ <h1>skbio.stats.composition.dirmult_lme<a class="headerlink" href="#skbio-stats-
773773
Case-insensitive. If None, no correction will be performed.</p>
774774
</dd>
775775
<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>
776+
Dirichlet distribution. See <a class="reference internal" href="skbio.util.get_rng.html#skbio.util.get_rng" title="skbio.util.get_rng"><code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code></a>.</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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -769,7 +769,7 @@ <h1>skbio.stats.composition.dirmult_ttest<a class="headerlink" href="#skbio-stat
769769
Case-insensitive. If None, no correction will be performed.</p>
770770
</dd>
771771
<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>
772+
Dirichlet distribution. See <a class="reference internal" href="skbio.util.get_rng.html#skbio.util.get_rng" title="skbio.util.get_rng"><code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code></a>.</p>
773773
</dd>
774774
</dl>
775775
</dd>

docs/dev/generated/skbio.stats.distance.DistanceMatrix.permute.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -731,7 +731,7 @@ <h1>skbio.stats.distance.DistanceMatrix.permute<a class="headerlink" href="#skbi
731731
<code class="docutils literal notranslate"><span class="pre">DistanceMatrix</span></code> instance.</p>
732732
</dd>
733733
<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
734-
<code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code>.</p>
734+
<a class="reference internal" href="skbio.util.get_rng.html#skbio.util.get_rng" title="skbio.util.get_rng"><code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code></a>.</p>
735735
<div class="versionadded">
736736
<p><span class="versionmodified added">Added in version 0.6.3.</span></p>
737737
</div>

docs/dev/generated/skbio.stats.distance.anosim.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -753,7 +753,7 @@ <h1>skbio.stats.distance.anosim<a class="headerlink" href="#skbio-stats-distance
753753
will be <code class="docutils literal notranslate"><span class="pre">np.nan</span></code>.</p>
754754
</dd>
755755
<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
756-
<code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code>.</p>
756+
<a class="reference internal" href="skbio.util.get_rng.html#skbio.util.get_rng" title="skbio.util.get_rng"><code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code></a>.</p>
757757
<div class="versionadded">
758758
<p><span class="versionmodified added">Added in version 0.6.3.</span></p>
759759
</div>

docs/dev/generated/skbio.stats.distance.mantel.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -787,7 +787,7 @@ <h1>skbio.stats.distance.mantel<a class="headerlink" href="#skbio-stats-distance
787787
<code class="docutils literal notranslate"><span class="pre">array_like</span></code>.</p>
788788
</dd>
789789
<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
790-
<code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code>.</p>
790+
<a class="reference internal" href="skbio.util.get_rng.html#skbio.util.get_rng" title="skbio.util.get_rng"><code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code></a>.</p>
791791
<div class="versionadded">
792792
<p><span class="versionmodified added">Added in version 0.6.3.</span></p>
793793
</div>

docs/dev/generated/skbio.stats.distance.permanova.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -754,7 +754,7 @@ <h1>skbio.stats.distance.permanova<a class="headerlink" href="#skbio-stats-dista
754754
will be <code class="docutils literal notranslate"><span class="pre">np.nan</span></code>.</p>
755755
</dd>
756756
<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
757-
<code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code>.</p>
757+
<a class="reference internal" href="skbio.util.get_rng.html#skbio.util.get_rng" title="skbio.util.get_rng"><code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code></a>.</p>
758758
<div class="versionadded">
759759
<p><span class="versionmodified added">Added in version 0.6.3.</span></p>
760760
</div>

docs/dev/generated/skbio.stats.distance.permdisp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -762,7 +762,7 @@ <h1>skbio.stats.distance.permdisp<a class="headerlink" href="#skbio-stats-distan
762762
Not used if the <cite>eigh</cite> method is being selected.</p>
763763
</dd>
764764
<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
765-
<code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code>.</p>
765+
<a class="reference internal" href="skbio.util.get_rng.html#skbio.util.get_rng" title="skbio.util.get_rng"><code class="xref py py-func docutils literal notranslate"><span class="pre">details</span></code></a>.</p>
766766
<div class="versionadded">
767767
<p><span class="versionmodified added">Added in version 0.6.3.</span></p>
768768
</div>

0 commit comments

Comments
 (0)