biotest 0.2.0

Generate random test data for bioinformatics
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

//! Generate random test data for bioinformatics
//!
//! There's a feature for every file format that can be generated:
//! - [`fasta`](module@format::fasta)
//! - [`fastq`](module@format::fastq)
//! - [`vcf`](module@format::vcf)
//! - [`sequence`](module@format::sequence)

#![warn(missing_docs)]

/* std use */

/* crate use */
use rand::SeedableRng;

/* project use */

/* mod declaration */
pub mod constants;
pub mod values;
#[macro_use]
pub mod error;
pub mod format;

/* reexport */
pub use format::Format;

#[cfg(feature = "fasta")]
pub use format::fasta::Fasta;

#[cfg(feature = "fastq")]
pub use format::fastq::Fastq;

#[cfg(feature = "vcf")]
pub use format::vcf::Vcf;

#[cfg(feature = "sequence")]
pub use format::sequence::Sequence;

#[cfg(feature = "quality")]
pub use format::quality::Quality;

/// Create a random generator with [constants::SEED]
pub fn rand() -> rand::rngs::StdRng {
    rand::rngs::StdRng::from_seed(constants::SEED)
}

/// Create a random generator with a user seed
pub fn seeded_rand(seed: u64) -> rand::rngs::StdRng {
    rand::rngs::StdRng::seed_from_u64(seed)
}

#[cfg(test)]
mod tests {
    /* crate use */
    use rand::Rng;

    /* local use */
    use super::*;

    #[test]
    fn check_rand() {
        let mut rng = rand();

        assert_eq!(rng.gen::<u8>(), 27);
    }

    #[test]
    fn check_seeded_rand() {
        let mut rng = seeded_rand(42);

        assert_eq!(rng.gen::<u8>(), 162);
    }
}