Crate noodles_tabix

Source
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

  1. bgzipped,
  2. tab-delimited,
  3. grouped by reference sequence name, and
  4. 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§

async
Async tabix.
fs
tabix filesystem operations.
index
Tabix index.
io
Tabix I/O.

Type Aliases§

Index
A tabix index.