seq_here/lib.rs
1//!
2//! []()
3//! [](https://github.com/bio-here/seq-here)
4//! [](https://travis-ci.org/bio-here/seq-here)
5//! [](https://crates.io/crates/seq-here)
6//! [](https://docs.rs/seq-here)
7//! []()!
8//!
9//! **Notice**: This project is still under development and not yet ready for production use.
10//!
11//! This crate provides several functions for bio-sequence file processing. It is designed to be fast and easy to use.
12//!
13//! Use the crate in your project by adding the following to your `Cargo.toml`:
14//! ```toml
15//! seq-here = "0.0.2"
16//! ```
17//!
18//! There are 3 modules in this crate for different purposes:
19//! - **info**: Get basic information about the input sequence file(s).
20//! - **convert**: Convert or process incoming sequence file(s).
21//! - **extract**: Extract specified sequence segment or file data.
22//!
23//! ## Examples
24//! - Info module:
25//!
26//! ```rust
27//! use seq_here::info::{self, InfoOutput};
28//! use std::path::{Path, PathBuf};
29//! let paths = vec![PathBuf::from("tests/test.fa")];
30//! info::InfoFa::by_println(paths.clone());
31//! info::InfoFa::by_file(paths);
32//! ```
33//!
34//! - Convert module:
35//!
36//! ```rust
37//!
38//! ```
39//!
40//! - Extract module:
41//!
42//! ```rust
43//!
44//! ```
45//!
46
47pub mod convert;
48pub mod extract;
49pub mod info;
50
51mod error;
52pub mod utils;