Function index

pub fn index<P>(src: P) -> Result<Index>
where
    P: AsRef<Path>,

Indexes a bgzipped-compressed SAM file.

The input must be coordinate-sorted and marked as such in the SAM header, i.e., SO:coordinate.

See also csi::fs::write to write the resulting csi::Index to a file.

Examples

use noodles_sam as sam;
let index = sam::fs::index("sample.sam.gz")?;