Expand description
noodles-tabix handles the reading and writing of the tabix format.
A tabix (TBI) is an index file typically used to allow random access of an accompanied file that is
- bgzipped,
- tab-delimited,
- grouped by reference sequence name, and
- coordinate sorted by start position.
It can be used to find relevant records for a given genomic region.
§Examples
§Read a tabix file
use noodles_tabix as tabix;
let index = tabix::fs::read("sample.vcf.gz.tbi")?;
Re-exports§
pub use self::fs::read;
pub use self::fs::write;
pub use self::io::Reader;
pub use self::io::Writer;
pub use self::async::Reader as AsyncReader;
pub use self::async::Writer as AsyncWriter;
Modules§
Type Aliases§
- Index
- A tabix index.