adjustp 0.1.6

A crate to handle different p-value adjustments
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

use crate::{
    benjamini_hochberg::BenjaminiHochberg, benjamini_yekutieli::BenjaminiYekutieli,
    bonferroni::Bonferroni,
};
use num_traits::{Float, FromPrimitive};
use std::iter::Sum;

/// Define which adjustment procedure to use.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum Procedure {
    /// Performs the Bonferroni Correction
    Bonferroni,

    /// Performs the Benjamini-Hochberg Single-Step Correction
    BenjaminiHochberg,

    /// Performs the Benjamini-Yekutieli Double-Step Correction
    BenjaminiYekutieli,
}

/// Performs the adjustment procedure on a slice of floats.
/// This does not require the pvalues to be sorted and will perform the necessary sorting if required.
#[must_use]
pub fn adjust<T: Float + FromPrimitive + Sum>(pvalues: &[T], method: Procedure) -> Vec<T> {
    match method {
        Procedure::Bonferroni => Bonferroni::adjust_slice(pvalues),
        Procedure::BenjaminiHochberg => BenjaminiHochberg::adjust_slice(pvalues),
        Procedure::BenjaminiYekutieli => BenjaminiYekutieli::adjust_slice(pvalues),
    }
}

#[cfg(test)]
mod testing {
    use super::{adjust, Procedure};

    #[test]
    fn example() {
        let pvalues = vec![0.1, 0.2, 0.3, 0.4, 0.1];

        let adj_bonferroni = adjust(&pvalues, Procedure::Bonferroni);
        let adj_bh = adjust(&pvalues, Procedure::BenjaminiHochberg);
        let adj_by = adjust(&pvalues, Procedure::BenjaminiYekutieli);

        assert_eq!(adj_bonferroni, vec![0.5, 1.0, 1.0, 1.0, 0.5]);

        assert_eq!(adj_bh, vec![0.25, 0.3333333333333333, 0.375, 0.4, 0.25]);

        assert_eq!(
            adj_by,
            vec![
                0.5708333333333333,
                0.7611111111111112,
                0.8562500,
                0.9133333333333333,
                0.5708333333333333
            ]
        );
    }
}