Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/stats-base-dists-negative-binomial

Negative binomial distribution.

https://github.com/stdlib-js/stats-base-dists-negative-binomial

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.5%) to scientific vocabulary

Keywords

binomial discrete dist distribution javascript lib library negative node node-js nodejs probability standard statistics stats stdlib univariate
Last synced: 6 months ago · JSON representation ·

Repository

Negative binomial distribution.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
binomial discrete dist distribution javascript lib library negative node node-js nodejs probability standard statistics stats stdlib univariate
Created over 4 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

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!

Negative Binomial

NPM version Build Status Coverage Status <!-- dependencies -->

Negative binomial distribution.

## Installation ```bash npm install @stdlib/stats-base-dists-negative-binomial ``` 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 negativeBinomial = require( '@stdlib/stats-base-dists-negative-binomial' ); ``` #### negativeBinomial Negative binomial distribution. ```javascript var dist = negativeBinomial; // returns {...} ``` The namespace contains the following distribution functions:
- [`cdf( x, r, p )`][@stdlib/stats/base/dists/negative-binomial/cdf]: negative binomial distribution cumulative distribution function. - [`logpmf( x, r, p )`][@stdlib/stats/base/dists/negative-binomial/logpmf]: evaluate the natural logarithm of the probability mass function (PMF) for a negative binomial distribution. - [`mgf( t, r, p )`][@stdlib/stats/base/dists/negative-binomial/mgf]: negative binomial distribution moment-generating function (MGF). - [`pmf( x, r, p )`][@stdlib/stats/base/dists/negative-binomial/pmf]: negative binomial distribution probability mass function (PMF). - [`quantile( k, r, p )`][@stdlib/stats/base/dists/negative-binomial/quantile]: negative binomial distribution quantile function.
The namespace contains the following functions for calculating distribution properties:
- [`kurtosis( r, p )`][@stdlib/stats/base/dists/negative-binomial/kurtosis]: negative binomial distribution excess kurtosis. - [`mean( r, p )`][@stdlib/stats/base/dists/negative-binomial/mean]: negative binomial distribution expected value. - [`mode( r, p )`][@stdlib/stats/base/dists/negative-binomial/mode]: negative binomial distribution mode. - [`skewness( r, p )`][@stdlib/stats/base/dists/negative-binomial/skewness]: negative binomial distribution skewness. - [`stdev( r, p )`][@stdlib/stats/base/dists/negative-binomial/stdev]: negative binomial distribution standard deviation. - [`variance( r, p )`][@stdlib/stats/base/dists/negative-binomial/variance]: negative binomial distribution variance.
The namespace contains a constructor function for creating a [negative binomial][negative-binomial-distribution] distribution object.
- [`NegativeBinomial( [r, p] )`][@stdlib/stats/base/dists/negative-binomial/ctor]: negative binomial distribution constructor.
```javascript var NegativeBinomial = require( '@stdlib/stats-base-dists-negative-binomial' ).NegativeBinomial; var dist = new NegativeBinomial( 4.0, 0.2 ); var y = dist.pmf( 4.0 ); // returns ~0.023 ```
## Examples ```javascript var negativeBinomial = require( '@stdlib/stats-base-dists-negative-binomial' ); /* * Let's take an example of flipping a biased coin until getting 5 heads. * This situation can be modeled using a Negative Binomial distribution with r = 5 and p = 1/2. */ var r = 5.0; var p = 1/2; // Mean can be used to calculate the average number of trials needed to get 5 heads: console.log( negativeBinomial.mean( r, p ) ); // => 5 // PMF can be used to calculate the probability of getting heads on a specific trial (say on the 8th trial): console.log( negativeBinomial.pmf( 8, r, p ) ); // => ~0.06 // CDF can be used to calculate the probability up to a certain number of trials (say up to 8 trials): console.log( negativeBinomial.cdf( 8, r, p ) ); // => ~0.867 // Quantile can be used to calculate the number of trials at which you can be 80% confident that the actual number will not exceed: console.log( negativeBinomial.quantile( 0.8, r, p ) ); // => 7 // Standard deviation can be used to calculate the measure of the spread of trials around the mean: console.log( negativeBinomial.stdev( r, p ) ); // => ~3.162 // Skewness can be used to calculate the asymmetry of the distribution of trials: console.log( negativeBinomial.skewness( r, p ) ); // => ~0.949 // MGF can be used for more advanced statistical analyses and generating moments of the distribution: console.log( negativeBinomial.mgf( 0.5, r, p ) ); // => ~2277.597 ```
* * * ## 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] --- ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

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: 20
Last Year
  • Push event: 20

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 53
  • Total Committers: 1
  • Avg Commits per committer: 53.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 11
  • Committers: 1
  • Avg Commits per committer: 11.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 53
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 8,656 last-month
  • Total dependent packages: 4
  • Total dependent repositories: 2
  • Total versions: 11
  • Total maintainers: 4
npmjs.org: @stdlib/stats-base-dists-negative-binomial

Negative binomial distribution.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.1
    published over 1 year ago
  • Versions: 11
  • Dependent Packages: 4
  • Dependent Repositories: 2
  • Downloads: 8,656 Last month
Rankings
Dependent packages count: 4.5%
Dependent repos count: 8.0%
Downloads: 9.1%
Average: 10.5%
Stargazers count: 15.0%
Forks count: 15.9%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 7 months ago

Dependencies

package.json npm
  • @stdlib/assert-has-own-property ^0.0.x development
  • @stdlib/assert-is-function ^0.0.x development
  • @stdlib/assert-is-number ^0.0.x development
  • @stdlib/assert-is-positive-number ^0.0.x development
  • @stdlib/assert-is-probability ^0.0.x development
  • @stdlib/bench ^0.0.x development
  • @stdlib/constants-float64-e ^0.0.x development
  • @stdlib/constants-float64-eps ^0.0.x development
  • @stdlib/constants-float64-gamma-lanczos-g ^0.0.x development
  • @stdlib/constants-float64-max-ln ^0.0.x development
  • @stdlib/constants-float64-min-ln ^0.0.x development
  • @stdlib/constants-float64-ninf ^0.0.x development
  • @stdlib/constants-float64-pinf ^0.0.x development
  • @stdlib/constants-float64-sqrt-two ^0.0.x development
  • @stdlib/math-base-assert-is-nan ^0.0.x development
  • @stdlib/math-base-assert-is-nonnegative-integer ^0.0.x development
  • @stdlib/math-base-special-abs ^0.0.x development
  • @stdlib/math-base-special-betainc ^0.0.x development
  • @stdlib/math-base-special-ceil ^0.0.x development
  • @stdlib/math-base-special-erfcinv ^0.0.x development
  • @stdlib/math-base-special-exp ^0.0.x development
  • @stdlib/math-base-special-expm1 ^0.0.x development
  • @stdlib/math-base-special-floor ^0.0.x development
  • @stdlib/math-base-special-gamma-lanczos-sum-expg-scaled ^0.0.x development
  • @stdlib/math-base-special-ln ^0.0.x development
  • @stdlib/math-base-special-log1p ^0.0.x development
  • @stdlib/math-base-special-max ^0.0.x development
  • @stdlib/math-base-special-min ^0.0.x development
  • @stdlib/math-base-special-pow ^0.0.x development
  • @stdlib/math-base-special-round ^0.0.x development
  • @stdlib/math-base-special-sqrt ^0.0.x development
  • @stdlib/random-base-randu ^0.0.x development
  • @stdlib/random-base-uniform ^0.0.x development
  • @stdlib/string-format ^0.0.x development
  • @stdlib/utils-constant-function ^0.0.x development
  • @stdlib/utils-define-nonenumerable-read-only-accessor ^0.0.x development
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.0.x development
  • @stdlib/utils-define-property ^0.0.x development
  • @stdlib/utils-keys ^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/stats-base-dists-negative-binomial-cdf ^0.0.x
  • @stdlib/stats-base-dists-negative-binomial-ctor ^0.0.x
  • @stdlib/stats-base-dists-negative-binomial-kurtosis ^0.0.x
  • @stdlib/stats-base-dists-negative-binomial-logpmf ^0.0.x
  • @stdlib/stats-base-dists-negative-binomial-mean ^0.0.x
  • @stdlib/stats-base-dists-negative-binomial-mgf ^0.0.x
  • @stdlib/stats-base-dists-negative-binomial-mode ^0.0.x
  • @stdlib/stats-base-dists-negative-binomial-pmf ^0.0.x
  • @stdlib/stats-base-dists-negative-binomial-quantile ^0.0.x
  • @stdlib/stats-base-dists-negative-binomial-skewness ^0.0.x
  • @stdlib/stats-base-dists-negative-binomial-stdev ^0.0.x
  • @stdlib/stats-base-dists-negative-binomial-variance ^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