Skip to content

Commit e5dcc1f

Browse files
PlaneshifterPlaneshifter
committed
Update table of contents
1 parent 5fcf525 commit e5dcc1f

9 files changed

Lines changed: 245 additions & 20 deletions

File tree

‎lib/node_modules/@stdlib/stats/README.md‎

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The namespace exposes the following statistical tests:
4747

4848
- <span class="signature">[`anova1( x, factor[, opts] )`][@stdlib/stats/anova1]</span><span class="delimiter">: </span><span class="description">perform a one-way analysis of variance.</span>
4949
- <span class="signature">[`bartlettTest( a[,b,...,k][, opts] )`][@stdlib/stats/bartlett-test]</span><span class="delimiter">: </span><span class="description">compute Bartlett’s test for equal variances.</span>
50-
- <span class="signature">[`binomTest( x[, n][, opts] )`][@stdlib/stats/binom-test]</span><span class="delimiter">: </span><span class="description">exact test for the success probability in a Bernoulli experiment.</span>
50+
- <span class="signature">[`binomialTest( x[, n][, opts] )`][@stdlib/stats/binomial-test]</span><span class="delimiter">: </span><span class="description">exact test for the success probability in a Bernoulli experiment.</span>
5151
- <span class="signature">[`chi2gof( x, y[, ...args][, opts] )`][@stdlib/stats/chi2gof]</span><span class="delimiter">: </span><span class="description">perform a chi-square goodness-of-fit test.</span>
5252
- <span class="signature">[`flignerTest( a[,b,...,k][, opts] )`][@stdlib/stats/fligner-test]</span><span class="delimiter">: </span><span class="description">compute the Fligner-Killeen test for equal variances.</span>
5353
- <span class="signature">[`kruskalTest( a[,b,...,k][, opts] )`][@stdlib/stats/kruskal-test]</span><span class="delimiter">: </span><span class="description">compute the Kruskal-Wallis test for equal medians.</span>
@@ -63,11 +63,22 @@ The namespace exposes the following statistical tests:
6363

6464
<!-- </toc> -->
6565

66-
In addition, it contains an assortment of functions for computing statistics incrementally as part of the `incr` sub-namespace.
66+
In addition, it contains an assortment of functions for computing statistics incrementally as part of the `incr` sub-namespace and functions for computing statistics over iterators in the `iterators` namespace.
67+
68+
<!-- <toc pattern="+(incr|iter)"> -->
69+
70+
<div class="namespace-toc">
71+
72+
- <span class="signature">[`incr`][@stdlib/stats/incr]</span><span class="delimiter">: </span><span class="description">standard library functions for computing statistics incrementally.</span>
73+
- <span class="signature">[`iterators`][@stdlib/stats/iter]</span><span class="delimiter">: </span><span class="description">standard library functions for computing statistics over iterators.</span>
74+
75+
</div>
76+
77+
<!-- </toc> -->
6778

6879
Other statistical functions included are:
6980

70-
<!-- <toc pattern="*" ignore="+(*test*|chi2gof|anova1)" ignore="incr"> -->
81+
<!-- <toc pattern="*" ignore="+(*test*|chi2gof|anova1)" ignore="incr" ignore="iterators" > -->
7182

7283
<div class="namespace-toc">
7384

@@ -112,11 +123,15 @@ console.log( objectKeys( statistics ) );
112123

113124
[@stdlib/stats/ranks]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/ranks
114125

126+
[@stdlib/stats/incr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr
127+
128+
[@stdlib/stats/iter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/iter
129+
115130
[@stdlib/stats/anova1]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/anova1
116131

117132
[@stdlib/stats/bartlett-test]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/bartlett-test
118133

119-
[@stdlib/stats/binom-test]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/binom-test
134+
[@stdlib/stats/binomial-test]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/binomial-test
120135

121136
[@stdlib/stats/chi2gof]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/chi2gof
122137

‎lib/node_modules/@stdlib/stats/base/dists/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ var distributions = dists;
8282

8383
<div class="namespace-toc">
8484

85+
- <span class="signature">[`bernoulli`][@stdlib/stats/base/dists/bernoulli]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution.</span>
8586
- <span class="signature">[`binomial`][@stdlib/stats/base/dists/binomial]</span><span class="delimiter">: </span><span class="description">binomial distribution.</span>
8687
- <span class="signature">[`discreteUniform`][@stdlib/stats/base/dists/discrete-uniform]</span><span class="delimiter">: </span><span class="description">discrete uniform distribution.</span>
8788
- <span class="signature">[`geometric`][@stdlib/stats/base/dists/geometric]</span><span class="delimiter">: </span><span class="description">geometric distribution.</span>
@@ -134,6 +135,8 @@ console.log( objectKeys( dists ) );
134135

135136
[@stdlib/stats/base/dists/degenerate]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/degenerate
136137

138+
[@stdlib/stats/base/dists/bernoulli]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli
139+
137140
[@stdlib/stats/base/dists/binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/binomial
138141

139142
[@stdlib/stats/base/dists/discrete-uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/discrete-uniform

‎lib/node_modules/@stdlib/stats/base/dists/bernoulli/README.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,18 +43,46 @@ The namespace contains the following distribution functions:
4343

4444
<!-- <toc pattern="*+(cdf|pmf|mgf|quantile)*"> -->
4545

46+
<div class="namespace-toc">
47+
48+
- <span class="signature">[`cdf( x, p )`][@stdlib/stats/base/dists/bernoulli/cdf]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution cumulative distribution function.</span>
49+
- <span class="signature">[`mgf( t, p )`][@stdlib/stats/base/dists/bernoulli/mgf]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution moment-generating function (MGF).</span>
50+
- <span class="signature">[`pmf( x, p )`][@stdlib/stats/base/dists/bernoulli/pmf]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution probability mass function (PMF).</span>
51+
- <span class="signature">[`quantile( r, p )`][@stdlib/stats/base/dists/bernoulli/quantile]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution quantile function.</span>
52+
53+
</div>
54+
4655
<!-- </toc> -->
4756

4857
The namespace contains the following functions for calculating distribution properties:
4958

5059
<!-- <toc pattern="*+(entropy|kurtosis|mean|median|mode|skewness|stdev|variance)*"> -->
5160

61+
<div class="namespace-toc">
62+
63+
- <span class="signature">[`entropy( p )`][@stdlib/stats/base/dists/bernoulli/entropy]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution entropy.</span>
64+
- <span class="signature">[`kurtosis( p )`][@stdlib/stats/base/dists/bernoulli/kurtosis]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution excess kurtosis.</span>
65+
- <span class="signature">[`mean( p )`][@stdlib/stats/base/dists/bernoulli/mean]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution expected value.</span>
66+
- <span class="signature">[`median( p )`][@stdlib/stats/base/dists/bernoulli/median]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution median.</span>
67+
- <span class="signature">[`mode( p )`][@stdlib/stats/base/dists/bernoulli/mode]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution mode.</span>
68+
- <span class="signature">[`skewness( p )`][@stdlib/stats/base/dists/bernoulli/skewness]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution skewness.</span>
69+
- <span class="signature">[`stdev( p )`][@stdlib/stats/base/dists/bernoulli/stdev]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution standard deviation.</span>
70+
- <span class="signature">[`variance( p )`][@stdlib/stats/base/dists/bernoulli/variance]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution variance.</span>
71+
72+
</div>
73+
5274
<!-- </toc> -->
5375

5476
The namespace contains a constructor function for creating a [Bernoulli][bernoulli-distribution] distribution object.
5577

5678
<!-- <toc pattern="*ctor*"> -->
5779

80+
<div class="namespace-toc">
81+
82+
- <span class="signature">[`Bernoulli( [p] )`][@stdlib/stats/base/dists/bernoulli/ctor]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution constructor.</span>
83+
84+
</div>
85+
5886
<!-- </toc> -->
5987

6088
```javascript
@@ -98,6 +126,32 @@ console.log( objectKeys( bernoulli ) );
98126

99127
<!-- <toc-links> -->
100128

129+
[@stdlib/stats/base/dists/bernoulli/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli/ctor
130+
131+
[@stdlib/stats/base/dists/bernoulli/entropy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli/entropy
132+
133+
[@stdlib/stats/base/dists/bernoulli/kurtosis]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli/kurtosis
134+
135+
[@stdlib/stats/base/dists/bernoulli/mean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli/mean
136+
137+
[@stdlib/stats/base/dists/bernoulli/median]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli/median
138+
139+
[@stdlib/stats/base/dists/bernoulli/mode]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli/mode
140+
141+
[@stdlib/stats/base/dists/bernoulli/skewness]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli/skewness
142+
143+
[@stdlib/stats/base/dists/bernoulli/stdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli/stdev
144+
145+
[@stdlib/stats/base/dists/bernoulli/variance]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli/variance
146+
147+
[@stdlib/stats/base/dists/bernoulli/cdf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli/cdf
148+
149+
[@stdlib/stats/base/dists/bernoulli/mgf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli/mgf
150+
151+
[@stdlib/stats/base/dists/bernoulli/pmf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli/pmf
152+
153+
[@stdlib/stats/base/dists/bernoulli/quantile]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/bernoulli/quantile
154+
101155
<!-- </toc-links> -->
102156

103157
</section>

‎lib/node_modules/@stdlib/stats/base/dists/beta/README.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -124,35 +124,35 @@ console.log( objectKeys( beta ) );
124124

125125
<!-- <toc-links> -->
126126

127-
[@stdlib/stats/base/dists/beta/ctor]: https://github.com/stdlib-js/stdlib
127+
[@stdlib/stats/base/dists/beta/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/ctor
128128

129-
[@stdlib/stats/base/dists/beta/entropy]: https://github.com/stdlib-js/stdlib
129+
[@stdlib/stats/base/dists/beta/entropy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/entropy
130130

131-
[@stdlib/stats/base/dists/beta/kurtosis]: https://github.com/stdlib-js/stdlib
131+
[@stdlib/stats/base/dists/beta/kurtosis]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/kurtosis
132132

133-
[@stdlib/stats/base/dists/beta/mean]: https://github.com/stdlib-js/stdlib
133+
[@stdlib/stats/base/dists/beta/mean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/mean
134134

135-
[@stdlib/stats/base/dists/beta/median]: https://github.com/stdlib-js/stdlib
135+
[@stdlib/stats/base/dists/beta/median]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/median
136136

137-
[@stdlib/stats/base/dists/beta/mode]: https://github.com/stdlib-js/stdlib
137+
[@stdlib/stats/base/dists/beta/mode]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/mode
138138

139-
[@stdlib/stats/base/dists/beta/skewness]: https://github.com/stdlib-js/stdlib
139+
[@stdlib/stats/base/dists/beta/skewness]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/skewness
140140

141-
[@stdlib/stats/base/dists/beta/stdev]: https://github.com/stdlib-js/stdlib
141+
[@stdlib/stats/base/dists/beta/stdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/stdev
142142

143-
[@stdlib/stats/base/dists/beta/variance]: https://github.com/stdlib-js/stdlib
143+
[@stdlib/stats/base/dists/beta/variance]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/variance
144144

145-
[@stdlib/stats/base/dists/beta/cdf]: https://github.com/stdlib-js/stdlib
145+
[@stdlib/stats/base/dists/beta/cdf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/cdf
146146

147-
[@stdlib/stats/base/dists/beta/logcdf]: https://github.com/stdlib-js/stdlib
147+
[@stdlib/stats/base/dists/beta/logcdf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/logcdf
148148

149-
[@stdlib/stats/base/dists/beta/logpdf]: https://github.com/stdlib-js/stdlib
149+
[@stdlib/stats/base/dists/beta/logpdf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/logpdf
150150

151-
[@stdlib/stats/base/dists/beta/mgf]: https://github.com/stdlib-js/stdlib
151+
[@stdlib/stats/base/dists/beta/mgf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/mgf
152152

153-
[@stdlib/stats/base/dists/beta/pdf]: https://github.com/stdlib-js/stdlib
153+
[@stdlib/stats/base/dists/beta/pdf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/pdf
154154

155-
[@stdlib/stats/base/dists/beta/quantile]: https://github.com/stdlib-js/stdlib
155+
[@stdlib/stats/base/dists/beta/quantile]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/beta/quantile
156156

157157
<!-- </toc-links> -->
158158

‎lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ The namespace contains the following distribution functions:
4848
- <span class="signature">[`cdf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/cdf]</span><span class="delimiter">: </span><span class="description">discrete uniform distribution cumulative distribution function.</span>
4949
- <span class="signature">[`logcdf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/logcdf]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of the cumulative distribution function for a discrete uniform distribution.</span>
5050
- <span class="signature">[`logpmf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/logpmf]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of the probability mass function (PMF) for a discrete uniform distribution.</span>
51+
- <span class="signature">[`mgf( t, a, b )`][@stdlib/stats/base/dists/discrete-uniform/mgf]</span><span class="delimiter">: </span><span class="description">discrete uniform distribution moment-generating function (MGF).</span>
5152
- <span class="signature">[`pmf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/pmf]</span><span class="delimiter">: </span><span class="description">discrete uniform distribution probability mass function (PMF).</span>
5253
- <span class="signature">[`quantile( p, a, b )`][@stdlib/stats/base/dists/discrete-uniform/quantile]</span><span class="delimiter">: </span><span class="description">discrete uniform distribution quantile function.</span>
5354

@@ -145,6 +146,8 @@ console.log( objectKeys( discreteUniform ) );
145146

146147
[@stdlib/stats/base/dists/discrete-uniform/logpmf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/discrete-uniform/logpmf
147148

149+
[@stdlib/stats/base/dists/discrete-uniform/mgf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/discrete-uniform/mgf
150+
148151
[@stdlib/stats/base/dists/discrete-uniform/pmf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/discrete-uniform/pmf
149152

150153
[@stdlib/stats/base/dists/discrete-uniform/quantile]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/discrete-uniform/quantile

‎lib/node_modules/@stdlib/stats/base/dists/frechet/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The namespace contains the following distribution functions:
4949
- <span class="signature">[`logcdf( x, alpha, s, m )`][@stdlib/stats/base/dists/frechet/logcdf]</span><span class="delimiter">: </span><span class="description">Fréchet distribution logarithm of cumulative distribution function.</span>
5050
- <span class="signature">[`logpdf( x, alpha, s, m )`][@stdlib/stats/base/dists/frechet/logpdf]</span><span class="delimiter">: </span><span class="description">Fréchet distribution logarithm of probability density function.</span>
5151
- <span class="signature">[`pdf( x, alpha, s, m )`][@stdlib/stats/base/dists/frechet/pdf]</span><span class="delimiter">: </span><span class="description">Fréchet distribution probability density function.</span>
52-
- <span class="signature">[`quantile( x, alpha, s, m )`][@stdlib/stats/base/dists/frechet/quantile]</span><span class="delimiter">: </span><span class="description">Fréchet distribution quantile function.</span>
52+
- <span class="signature">[`quantile( p, alpha, s, m )`][@stdlib/stats/base/dists/frechet/quantile]</span><span class="delimiter">: </span><span class="description">Fréchet distribution quantile function.</span>
5353

5454
</div>
5555

‎lib/node_modules/@stdlib/stats/base/dists/pareto-type1/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ The namespace contains the following functions for calculating distribution prop
6767
- <span class="signature">[`median( alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/median]</span><span class="delimiter">: </span><span class="description">Pareto (Type I) distribution median.</span>
6868
- <span class="signature">[`mode( alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/mode]</span><span class="delimiter">: </span><span class="description">Pareto (Type I) distribution mode.</span>
6969
- <span class="signature">[`skewness( alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/skewness]</span><span class="delimiter">: </span><span class="description">Pareto (Type I) distribution skewness.</span>
70+
- <span class="signature">[`stdev( alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/stdev]</span><span class="delimiter">: </span><span class="description">Pareto (Type I) distribution standard deviation.</span>
7071
- <span class="signature">[`variance( alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/variance]</span><span class="delimiter">: </span><span class="description">Pareto (Type I) distribution variance.</span>
7172

7273
</div>
@@ -137,6 +138,8 @@ console.log( objectKeys( pareto1 ) );
137138

138139
[@stdlib/stats/base/dists/pareto-type1/skewness]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/pareto-type1/skewness
139140

141+
[@stdlib/stats/base/dists/pareto-type1/stdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/pareto-type1/stdev
142+
140143
[@stdlib/stats/base/dists/pareto-type1/variance]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/pareto-type1/variance
141144

142145
[@stdlib/stats/base/dists/pareto-type1/cdf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/pareto-type1/cdf

0 commit comments

Comments
 (0)