- Coverage
- 100%
10 out of 10 items documented5 out of 9 items with examples - Links
- Homepage
-
zaeleus/noodles
514 53 8 - crates.io
- Dependencies
- Versions
-
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.1
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.9.0
- 0.8.1
- 0.8.0
- 0.7.3
- 0.7.2
- 0.7.1
- 0.7.0
- 0.6.1
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
- Owners
-
**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.
[tabix format]: https://samtools.github.io/hts-specs/tabix.pdf
# Examples
## Read a tabix file
```no_run
# use std::io;
use noodles_tabix as tabix;
let index = tabix::read("sample.vcf.gz.tbi")?;
# Ok::<(), io::Error>(())
```