angsd_saf/
lib.rs

1//! Reading and writing of the SAF format.
2//!
3//! # Examples
4//!
5//! Read SAF v3 file:
6//!
7//! ```no_run
8#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/examples/saf_v3_read.rs"))]
9//! ```
10//!
11//! Write SAF v3 file:
12//!
13//! ```no_run
14#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/examples/saf_v3_write.rs"))]
15//! ```
16//!
17//! Read only intersecting sites in multiple SAF v3 files:
18//!
19//! ```no_run
20#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/examples/saf_v3_intersect.rs"))]
21//! ```
22//!
23//! The above examples are also available as runnable binaries,
24//! see the repository `examples/` folder.
25
26pub use angsd_io_core::ReadStatus;
27
28pub mod ext;
29
30pub mod index;
31pub use index::Index;
32
33pub mod reader;
34pub use reader::{Intersect, Reader, ReaderV3, ReaderV4};
35
36pub mod record;
37pub use record::Record;
38
39pub mod version;
40
41pub mod writer;
42pub use writer::{Writer, WriterV3, WriterV4};