adjustp

Crates.ioadjustp
lib.rsadjustp
version0.1.6
sourcesrc
created_at2022-08-19 20:58:02.802417
updated_at2024-06-28 19:25:46.410655
descriptionA crate to handle different p-value adjustments
homepage
repositoryhttps://github.com/noamteyssier/adjustp
max_upload_size
id648883
size19,001
Noam Teyssier (noamteyssier)

documentation

https://docs.rs/adjustp

README

adjustp

Summary

This is a crate to perform pvalue adjustments for multiple hypothesis tests and is inspired by the R function p.adjust.

There are currently only three methods available: Bonferroni, Benjamini-Hochberg, and Benjamini-Yekutieli.

This crate gives a single interface for each of these multiple hypothesis corrections and does not expect the p-values to be presorted before calculating.

Usage

The main interface for the tests is through the adjust function, which takes a slice of f64 and a Procedure. If you are using ndarray you can use this easily with the .as_slice() function.

Basic Usage

Here's an example for a Bonferroni correction.

use adjustp::{adjust, Procedure};

let pvalues = vec![0.1, 0.2, 0.3, 0.4, 0.1];
let qvalues = adjust(&pvalues, Procedure::Bonferroni);
assert_eq!(qvalues, vec![0.5, 1.0, 1.0, 1.0, 0.5]);

And another example for a BenjaminiHochberg adjustment.

use adjustp::{adjust, Procedure};

let pvalues = vec![0.1, 0.2, 0.3, 0.4, 0.1];
let qvalues = adjust(&pvalues, Procedure::BenjaminiHochberg);
assert_eq!(qvalues, vec![0.25, 0.33333333333333337, 0.375, 0.4, 0.25]);

And another example for a BenjaminiYekutieli adjustment.

use adjustp::{adjust, Procedure};

let pvalues = vec![0.1, 0.2, 0.3, 0.4, 0.1];
let qvalues = adjust(&pvalues, Procedure::BenjaminiYekutieli);
assert_eq!(qvalues, vec![0.5708333333333333, 0.7611111111111111, 0.8562500, 0.91333333333333333, 0.5708333333333333]);
Commit count: 16

cargo fmt