binomtest 0.1.0

Lightweight crate providing binomial test.
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

# binomtest

binomtest is a lightweight Rust crate that provides the `binomial-test` function for hypothesis testing of binary outcomes.

## Overview

The binomial_test function calculates the p-value for the binomial test given:

- The number of observed successes,

- The total number of trials,

- The hypothesized probability of success under the null hypothesis,

- The alternative hypothesis type (two-sided, greater, or less).


## Usage

Add the crate to your Cargo.toml:

```
[dependencies]
binomial-test = "0.1.0"
```

Use the function in your Rust code:

```
use binomtest::*;

fn main() {
    let successes = 5;
    let trials = 10;
    let p_null = 0.5;
    let alt = Alternative::TwoSided;

    match binomial_test(successes, trials, p_null, alt) {
        Ok(p_value) => println!("P-value: {}", p_value),
        Err(e) => eprintln!("Error: {}", e),
    }
}
```

#### Alternative Hypothesis

The crate supports three types of alternative hypotheses through the Alternative enum:

- TwoSided
- Greater
- Less

# License
binomtest is released under the MIT license. See [LICENSE](LICENSE) for more information.