statrs

Statrs provides a host of statistical utilities for Rust scientific computing.

Included are a number of common distributions that can be sampled (i.e. Normal, Exponential, Student's T, Gamma, Uniform, etc.) plus common statistical functions like the gamma function, beta function, and error function.

This library began as port of the statistical capabilities in the C# Math.NET library. All unit tests in the library borrowed from Math.NET when possible and filled-in when not. Planned for future releases are continued implementations of distributions as well as porting over more statistical utilities.

Please check out the documentation here.

Usage

Add the most recent release to your Cargo.toml

[dependencies]
statrs = "*" # replace * by the latest version of the crate.

For examples, view the docs.

Contributing

Thanks for your help to improve the project! No contribution is too small and all contributions are valued.

Suggestions if you don't know where to start,

documentation is a great place to start, as you'll be able to identify the value of existing documentation better than its authors.
tests are valuable in demonstrating correct behavior, you can review test coverage on the CodeCov Report*, not live until #229 merged.
check out some of the issues marked help wanted.
look at what's not included from Math.NET's Distributions, Statistics, or related.

How to contribute

Clone the repo:

git clone https://github.com/statrs-dev/statrs

Create a feature branch:

git checkout -b <feature_branch> master

Write your code and docs, then ensure it is formatted:

The below sample modify in-place, use --check flag to view diff without making file changes. Not using fmt from +nightly may result in some warnings and different formatting. Our CI will fmt, but less chores in commit history are appreciated.

cargo +nightly fmt

After commiting your code:

git push -u origin <feature_branch>

Then submit a PR, preferably referencing the relevant issue, if it exists.

Commit messages

Please be explicit and and purposeful with commit messages. Conventional Commits encouraged.

Bad

Modify test code

Good

test: Update statrs::distribution::Normal test_cdf

Communication Expectations

Please allow at least one week before pinging issues/pr's.

AlessioZanga/statrs