dhtslib.faidx

This module provides a wrapper, IndexedFastaFile over a FASTA. If an index exists, it will be used for rapid random access. If an index does not exist, one will be built.

The wrapper provides the ability to list sequence names (i.e., chromosomes/contigs) in the FASTA, efficiently retrieve sequences (by contig, start, end)

Sequence caching and multithreaded BGZF decompression are supported.

Members

Functions

buildFastaIndex
bool buildFastaIndex(string fn, string fnfai, string fngzi)

Build index for a FASTA or bgzip-compressed FASTA file.

Structs

IndexedFastaFile
struct IndexedFastaFile

FASTA file with .fai or .gzi index

Meta