@stdlib/stats-ttest

One-sample and paired Student's t-Test.

https://github.com/stdlib-js/stats-ttest

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary

Keywords

hypothesis javascript math mathematics mean node node-js nodejs paired statistics stats stdlib summary test

Last synced: 6 months ago · JSON representation ·

Repository

One-sample and paired Student's t-Test.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 3.88 MB

Statistics

Stars: 5
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

hypothesis javascript math mathematics mean node node-js nodejs paired statistics stats stdlib summary test

Created over 4 years ago · Last pushed 8 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Student's t-Test

One-sample and paired Student's t-Test.

## Installation ```bash npm install @stdlib/stats-ttest ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage ```javascript var ttest = require( '@stdlib/stats-ttest' ); ``` #### ttest( x\[, y]\[, opts] ) The function performs a one-sample t-test for the null hypothesis that the data in [array][mdn-array] or [typed array][mdn-typed-array] `x` is drawn from a normal distribution with mean zero and unknown variance. ```javascript var normal = require( '@stdlib/random-base-normal' ).factory; var rnorm; var arr; var out; var i; rnorm = normal( 0.0, 2.0, { 'seed': 5776 }); arr = new Array( 100 ); for ( i = 0; i < arr.length; i++ ) { arr[ i ] = rnorm(); } out = ttest( arr ); /* e.g., returns { 'rejected': false, 'pValue': ~0.722, 'statistic': ~0.357, 'ci': [~-0.333,~0.479], // ... } */ ``` When [array][mdn-array] or [typed array][mdn-typed-array] `y` is supplied, the function tests whether the differences `x - y` come from a normal distribution with mean zero and unknown variance via the paired t-test. ```javascript var normal = require( '@stdlib/random-base-normal' ).factory; var rnorm; var out; var i; var x; var y; rnorm = normal( 1.0, 2.0, { 'seed': 786 }); x = new Array( 100 ); y = new Array( 100 ); for ( i = 0; i < x.length; i++ ) { x[ i ] = rnorm(); y[ i ] = rnorm(); } out = ttest( x, y ); /* e.g., returns { 'rejected': false, 'pValue': ~0.191, 'statistic': ~1.315, 'ci': [ ~-0.196, ~0.964 ], // ... } */ ``` The returned object comes with a `.print()` method which when invoked will print a formatted output of the hypothesis test results. `print` accepts a `digits` option that controls the number of decimal digits displayed for the outputs and a `decision` option, which when set to `false` will hide the test decision. ```javascript console.log( out.print() ); /* e.g., => Paired t-test Alternative hypothesis: True difference in means is not equal to 0 pValue: 0.1916 statistic: 1.3148 df: 99 95% confidence interval: [-0.1955,0.9635] Test Decision: Fail to reject null in favor of alternative at 5% significance level */ ``` The `ttest` function accepts the following `options`: - **alpha**: `number` in the interval `[0,1]` giving the significance level of the hypothesis test. Default: `0.05`. - **alternative**: Either `two-sided`, `less` or `greater`. Indicates whether the alternative hypothesis is that the mean of `x` is larger than `mu` (`greater`), smaller than `mu` (`less`) or equal to `mu` (`two-sided`). Default: `two-sided`. - **mu**: `number` denoting the hypothesized true mean under the null hypothesis. Default: `0`. By default, the hypothesis test is carried out at a significance level of `0.05`. To choose a different significance level, set the `alpha` option. ```javascript var table; var out; var arr; arr = [ 2, 4, 3, 1, 0 ]; out = ttest( arr, { 'alpha': 0.01 }); table = out.print(); /* e.g., returns One-sample t-test Alternative hypothesis: True mean is not equal to 0 pValue: 0.0474 statistic: 2.8284 df: 4 99% confidence interval: [-1.2556,5.2556] Test Decision: Fail to reject null in favor of alternative at 1% significance level */ out = ttest( arr, { 'alpha': 0.1 }); table = out.print(); /* e.g., returns One-sample t-test Alternative hypothesis: True mean is not equal to 0 pValue: 0.0474 statistic: 2.8284 df: 4 90% confidence interval: [0.4926,3.5074] Test Decision: Reject null in favor of alternative at 10% significance level */ ``` To test whether the data comes from a distribution with a mean different than zero, set the `mu` option. ```javascript var out; var arr; arr = [ 4, 4, 6, 6, 5 ]; out = ttest( arr, { 'mu': 5 }); /* e.g., returns { 'rejected': false, 'pValue': 1, 'statistic': 0, 'ci': [ ~3.758, ~6.242 ], // ... } */ ``` By default, a two-sided test is performed. To perform either of the one-sided tests, set the `alternative` option to `less` or `greater`. ```javascript var table; var out; var arr; arr = [ 4, 4, 6, 6, 5 ]; out = ttest( arr, { 'alternative': 'less' }); table = out.print(); /* e.g., returns One-sample t-test Alternative hypothesis: True mean is less than 0 pValue: 0.9998 statistic: 11.1803 df: 4 95% confidence interval: [-Infinity,5.9534] Test Decision: Fail to reject null in favor of alternative at 5% significance level */ out = ttest( arr, { 'alternative': 'greater' }); table = out.print(); /* e.g., returns One-sample t-test Alternative hypothesis: True mean is greater than 0 pValue: 0.0002 statistic: 11.1803 df: 4 95% confidence interval: [4.0466,Infinity] Test Decision: Reject null in favor of alternative at 5% significance level */ ```

## Examples ```javascript var normal = require( '@stdlib/random-base-normal' ).factory; var ttest = require( '@stdlib/stats-ttest' ); var rnorm; var arr; var out; var i; rnorm = normal( 5.0, 4.0, { 'seed': 37827 }); arr = new Array( 100 ); for ( i = 0; i < arr.length; i++ ) { arr[ i ] = rnorm(); } // Test whether true mean is equal to zero: out = ttest( arr ); console.log( out.print() ); /* e.g., => One-sample t-test Alternative hypothesis: True mean is not equal to 0 pValue: 0 statistic: 15.0513 df: 99 95% confidence interval: [4.6997,6.127] Test Decision: Reject null in favor of alternative at 5% significance level */ // Test whether true mean is equal to five: out = ttest( arr, { 'mu': 5.0 }); console.log( out.print() ); /* e.g., => One-sample t-test Alternative hypothesis: True mean is not equal to 5 pValue: 0.2532 statistic: 1.1494 df: 99 95% confidence interval: [4.6997,6.127] Test Decision: Fail to reject null in favor of alternative at 5% significance level */ ```

* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 22

Last Year

Push event: 22

Committers

Last synced: about 2 years ago

All Time

Total Commits: 45
Total Committers: 1
Avg Commits per committer: 45.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 8
Committers: 1
Avg Commits per committer: 8.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	45

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Packages

Total packages: 1
Total downloads:
- npm 1,719 last-month

Total dependent packages: 2
Total dependent repositories: 0
Total versions: 11
Total maintainers: 4

npmjs.org: @stdlib/stats-ttest

One-sample and paired Student's t-Test.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 11
Dependent Packages: 2
Dependent Repositories: 0
Downloads: 1,719 Last month

Rankings

Downloads: 3.2%

Dependent packages count: 9.5%

Average: 14.0%

Stargazers count: 14.6%

Forks count: 17.4%

Dependent repos count: 25.3%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 6 months ago

Dependencies

test/fixtures/r/DESCRIPTION cran

R >=3.4.0 depends
jsonlite * imports

package.json npm

@stdlib/assert-is-object ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/constants-float64-eps ^0.0.x development
@stdlib/random-base-normal ^0.0.x development
@stdlib/random-base-randu ^0.0.x development
istanbul ^0.4.1 development
tap-spec 5.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/array-float64 ^0.0.x
@stdlib/assert-contains ^0.0.x
@stdlib/assert-has-own-property ^0.0.x
@stdlib/assert-is-boolean ^0.0.x
@stdlib/assert-is-number ^0.0.x
@stdlib/assert-is-number-array ^0.0.x
@stdlib/assert-is-plain-object ^0.0.x
@stdlib/assert-is-positive-integer ^0.0.x
@stdlib/assert-is-string ^0.0.x
@stdlib/assert-is-typed-array-like ^0.0.x
@stdlib/blas-base-gcopy ^0.0.x
@stdlib/constants-float64-ninf ^0.0.x
@stdlib/constants-float64-pinf ^0.0.x
@stdlib/math-base-assert-is-nan ^0.0.x
@stdlib/math-base-special-abs ^0.0.x
@stdlib/math-base-special-roundn ^0.0.x
@stdlib/math-base-special-sqrt ^0.0.x
@stdlib/stats-base-dists-t-cdf ^0.0.x
@stdlib/stats-base-dists-t-quantile ^0.0.x
@stdlib/stats-base-mean ^0.0.x
@stdlib/stats-base-variance ^0.0.x
@stdlib/string-format ^0.0.x
@stdlib/types ^0.0.x
@stdlib/utils-define-read-only-property ^0.0.x

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/stats-ttest

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Student's t-Test

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Packages

npmjs.org: @stdlib/stats-ttest

Rankings

Maintainers (4)

Funding

Dependencies