rsfgsea 0.3.4

High-performance fgsea-compatible preranked Gene Set Enrichment Analysis in Rust
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum InterfaceMode {
    Multilevel,
    Simple,
    Fgsea,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ExecutionPlan {
    Cpu(InterfaceMode),
    Gpu {
        mode: InterfaceMode,
        n_perm: usize,
        allow_multilevel: bool,
    },
}

pub fn parse_interface_mode(mode: &str) -> Result<InterfaceMode, String> {
    match mode.to_lowercase().as_str() {
        "multilevel" => Ok(InterfaceMode::Multilevel),
        "simple" => Ok(InterfaceMode::Simple),
        "fgsea" => Ok(InterfaceMode::Fgsea),
        other => Err(format!(
            "Invalid mode '{}'. Expected one of: fgsea, multilevel, simple.",
            other
        )),
    }
}

pub fn resolve_execution_plan(
    mode: InterfaceMode,
    gpu: bool,
    nperm: Option<usize>,
    n_perm_simple: usize,
) -> Result<ExecutionPlan, String> {
    if !gpu {
        return Ok(ExecutionPlan::Cpu(mode));
    }

    if mode == InterfaceMode::Multilevel && nperm.is_some() {
        return Err("nperm is only valid with mode='fgsea' or mode='simple'.".to_string());
    }

    let (n_perm, allow_multilevel) = match mode {
        InterfaceMode::Multilevel => (n_perm_simple, true),
        InterfaceMode::Simple => (nperm.unwrap_or(n_perm_simple), false),
        InterfaceMode::Fgsea => (nperm.unwrap_or(n_perm_simple), nperm.is_none()),
    };

    Ok(ExecutionPlan::Gpu {
        mode,
        n_perm,
        allow_multilevel,
    })
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parse_interface_mode_accepts_supported_values() {
        assert_eq!(parse_interface_mode("fgsea").unwrap(), InterfaceMode::Fgsea);
        assert_eq!(
            parse_interface_mode("multilevel").unwrap(),
            InterfaceMode::Multilevel
        );
        assert_eq!(
            parse_interface_mode("simple").unwrap(),
            InterfaceMode::Simple
        );
    }

    #[test]
    fn resolve_execution_plan_for_cpu_preserves_requested_mode() {
        assert_eq!(
            resolve_execution_plan(InterfaceMode::Fgsea, false, None, 1000).unwrap(),
            ExecutionPlan::Cpu(InterfaceMode::Fgsea)
        );
        assert_eq!(
            resolve_execution_plan(InterfaceMode::Multilevel, false, None, 1000).unwrap(),
            ExecutionPlan::Cpu(InterfaceMode::Multilevel)
        );
        assert_eq!(
            resolve_execution_plan(InterfaceMode::Simple, false, Some(250), 1000).unwrap(),
            ExecutionPlan::Cpu(InterfaceMode::Simple)
        );
    }

    #[test]
    fn resolve_execution_plan_for_gpu_exposes_wrapper_and_explicit_modes() {
        assert_eq!(
            resolve_execution_plan(InterfaceMode::Fgsea, true, None, 1000).unwrap(),
            ExecutionPlan::Gpu {
                mode: InterfaceMode::Fgsea,
                n_perm: 1000,
                allow_multilevel: true,
            }
        );
        assert_eq!(
            resolve_execution_plan(InterfaceMode::Fgsea, true, Some(250), 1000).unwrap(),
            ExecutionPlan::Gpu {
                mode: InterfaceMode::Fgsea,
                n_perm: 250,
                allow_multilevel: false,
            }
        );
        assert_eq!(
            resolve_execution_plan(InterfaceMode::Simple, true, Some(250), 1000).unwrap(),
            ExecutionPlan::Gpu {
                mode: InterfaceMode::Simple,
                n_perm: 250,
                allow_multilevel: false,
            }
        );
        assert_eq!(
            resolve_execution_plan(InterfaceMode::Multilevel, true, None, 1000).unwrap(),
            ExecutionPlan::Gpu {
                mode: InterfaceMode::Multilevel,
                n_perm: 1000,
                allow_multilevel: true,
            }
        );
    }

    #[test]
    fn resolve_execution_plan_rejects_nperm_for_multilevel_gpu() {
        let err =
            resolve_execution_plan(InterfaceMode::Multilevel, true, Some(250), 1000).unwrap_err();
        assert_eq!(
            err,
            "nperm is only valid with mode='fgsea' or mode='simple'."
        );
    }
}