<commit_before><!--

@license Apache-2.0

Copyright (c) 2018 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# Stats

> Standard library statistical functions.

<section class="usage">

## Usage

```javascript
var statistics = require( '@stdlib/math/stats' );
```

#### statistics

Standard library statistical functions.

```javascript
var stats = statistics;
// returns {...}
```

The namespace exposes the following statistical tests:

<!-- <toc pattern="+(*test*|chi2gof|anova1)"> -->

<div class="namespace-toc">

-   <span class="signature">[`anova1( x, factor[, opts] )`][@stdlib/math/stats/anova1]</span><span class="delimiter">: </span><span class="description">perform a one-way analysis of variance.</span>
-   <span class="signature">[`chi2gof( x, y[, ...params][, opts] )`][@stdlib/math/stats/chi2gof]</span><span class="delimiter">: </span><span class="description">perform a chi-square goodness-of-fit test.</span>
-   <span class="signature">[`kstest( x, y[, ...params][, opts] )`][@stdlib/math/stats/kstest]</span><span class="delimiter">: </span><span class="description">one-sample Kolmogorov-Smirnov goodness-of-fit test.</span>
-   <span class="signature">[`pcorrtest( x, y[, opts] )`][@stdlib/math/stats/pcorrtest]</span><span class="delimiter">: </span><span class="description">compute a Pearson product-moment correlation test between paired samples.</span>
-   <span class="signature">[`ttest( x[, y][, opts] )`][@stdlib/math/stats/ttest]</span><span class="delimiter">: </span><span class="description">one-sample and paired Student's t-Test.</span>
-   <span class="signature">[`ttest2( x, y[, opts] )`][@stdlib/math/stats/ttest2]</span><span class="delimiter">: </span><span class="description">two-sample Student's t-Test.</span>
-   <span class="signature">[`ztest( x, sigma[, opts] )`][@stdlib/math/stats/ztest]</span><span class="delimiter">: </span><span class="description">one-sample z-Test.</span>

</div>

<!-- </toc> -->

In addition, it contains an assortment of functions for computing statistics incrementally as part of the `incr` sub-namespace.

Other statistical functions included are:

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

<div class="namespace-toc">

-   <span class="signature">[`lowess( x, y[, opts] )`][@stdlib/math/stats/lowess]</span><span class="delimiter">: </span><span class="description">locally-weighted polynomial regression via the LOWESS algorithm.</span>

</div>

<!-- </toc> -->

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- TODO: better examples -->

<!-- eslint no-undef: "error" -->

```javascript
var getKeys = require( 'object-keys' ).shim();
var statistics = require( '@stdlib/math/stats' );

console.log( getKeys( statistics ) );
```

</section>

<!-- /.examples -->

<section class="links">

<!-- <toc-links> -->

[@stdlib/math/stats/lowess]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/lowess

[@stdlib/math/stats/anova1]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/anova1

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

[@stdlib/math/stats/kstest]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/kstest

[@stdlib/math/stats/pcorrtest]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/pcorrtest

[@stdlib/math/stats/ttest]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/ttest

[@stdlib/math/stats/ttest2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/ttest2

[@stdlib/math/stats/ztest]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/ztest

<!-- </toc-links> -->

</section>

<!-- /.links -->
<commit_msg>Fix table of contents<commit_after><!--

@license Apache-2.0

Copyright (c) 2018 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# Stats

> Standard library statistical functions.

<section class="usage">

## Usage

```javascript
var statistics = require( '@stdlib/math/stats' );
```

#### statistics

Standard library statistical functions.

```javascript
var stats = statistics;
// returns {...}
```

The namespace exposes the following statistical tests:

<!-- <toc pattern="+(*test*|chi2gof|anova1)"> -->

<div class="namespace-toc">

-   <span class="signature">[`anova1( x, factor[, opts] )`][@stdlib/math/stats/anova1]</span><span class="delimiter">: </span><span class="description">perform a one-way analysis of variance.</span>
-   <span class="signature">[`chi2gof( x, y[, ...params][, opts] )`][@stdlib/math/stats/chi2gof]</span><span class="delimiter">: </span><span class="description">perform a chi-square goodness-of-fit test.</span>
-   <span class="signature">[`kstest( x, y[, ...params][, opts] )`][@stdlib/math/stats/kstest]</span><span class="delimiter">: </span><span class="description">one-sample Kolmogorov-Smirnov goodness-of-fit test.</span>
-   <span class="signature">[`pcorrtest( x, y[, opts] )`][@stdlib/math/stats/pcorrtest]</span><span class="delimiter">: </span><span class="description">compute a Pearson product-moment correlation test between paired samples.</span>
-   <span class="signature">[`ttest( x[, y][, opts] )`][@stdlib/math/stats/ttest]</span><span class="delimiter">: </span><span class="description">one-sample and paired Student's t-Test.</span>
-   <span class="signature">[`ttest2( x, y[, opts] )`][@stdlib/math/stats/ttest2]</span><span class="delimiter">: </span><span class="description">two-sample Student's t-Test.</span>
-   <span class="signature">[`ztest( x, sigma[, opts] )`][@stdlib/math/stats/ztest]</span><span class="delimiter">: </span><span class="description">one-sample z-Test.</span>
-   <span class="signature">[`ztest2( x, y, sigmax, sigmay[, opts] )`][@stdlib/math/stats/ztest2]</span><span class="delimiter">: </span><span class="description">two-sample z-Test.</span>

</div>

<!-- </toc> -->

In addition, it contains an assortment of functions for computing statistics incrementally as part of the `incr` sub-namespace.

Other statistical functions included are:

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

<div class="namespace-toc">

-   <span class="signature">[`lowess( x, y[, opts] )`][@stdlib/math/stats/lowess]</span><span class="delimiter">: </span><span class="description">locally-weighted polynomial regression via the LOWESS algorithm.</span>

</div>

<!-- </toc> -->

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- TODO: better examples -->

<!-- eslint no-undef: "error" -->

```javascript
var getKeys = require( 'object-keys' ).shim();
var statistics = require( '@stdlib/math/stats' );

console.log( getKeys( statistics ) );
```

</section>

<!-- /.examples -->

<section class="links">

<!-- <toc-links> -->

[@stdlib/math/stats/lowess]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/lowess

[@stdlib/math/stats/anova1]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/anova1

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

[@stdlib/math/stats/kstest]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/kstest

[@stdlib/math/stats/pcorrtest]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/pcorrtest

[@stdlib/math/stats/ttest]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/ttest

[@stdlib/math/stats/ttest2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/ttest2

[@stdlib/math/stats/ztest]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/ztest

[@stdlib/math/stats/ztest2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/stats/ztest2

<!-- </toc-links> -->

</section>

<!-- /.links -->

{'fraction_non_alphanumeric': 0.19416839576280442, 'fraction_numerical': 0.009828546467183575, 'mean_word_length': 4.935191186001296, 'pattern_counts': {'":': 0, '<': 161, '<?xml version=': 0, '>': 163, 'https://': 17, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4617609', 'n_tokens_mistral': 3134, 'n_tokens_neox': 2909, 'n_words': 635}