correlation 0.1.0

A very simple crate that implements the calculation of correlation coefficients.
Documentation
  • Coverage
  • 75%
    3 out of 4 items documented3 out of 3 items with examples
  • Size
  • Source code size: 575.41 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.21 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 13s Average build duration of successful builds.
  • all releases: 13s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • mroget/correlation
    0 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • mroget

Correlation

A very simple crate that implements the calculation of correlation coefficients.

Usage

This crate implements:

Pearson

use correlation::pearsonr;

fn main() {
    let result = pearsonr(&vec![1.,2.,3.], &vec![1., 2., 3.]);
    let expected = 1.;
    assert!((result - expected).abs() <= 1e-7);
}

Spearman

use correlation::spearmanr;

fn main() {
    let result = spearmanr(&vec![1.,2.,3.], &vec![1., 2., 3.]);
    let expected = 1.;
    assert!((result - expected).abs() <= 1e-7);
}

Kendall (variant Tau-A)

use correlation::kendalltau;

fn main() {
    let result = kendalltau(&vec![1.,2.,3.], &vec![1., 2., 3.]);
    let expected = 1.;
    assert!((result - expected).abs() <= 1e-7);
}

Tests

These functions have been tested against their scipy.stats counterparts.

TODO

  • Add Kendall Tau-B variant
  • Add Kendall Tau-C variant