69 breaking releases

new 0.70.0 Nov 7, 2024
0.68.0 Sep 26, 2024
0.65.0 Jul 14, 2024
0.58.0 Mar 28, 2024
0.2.1 Jul 30, 2021

#125 in Science

Download history 368/week @ 2024-07-18 368/week @ 2024-07-25 1535/week @ 2024-08-01 1010/week @ 2024-08-08 988/week @ 2024-08-15 500/week @ 2024-08-22 816/week @ 2024-08-29 480/week @ 2024-09-05 431/week @ 2024-09-12 536/week @ 2024-09-19 691/week @ 2024-09-26 574/week @ 2024-10-03 1578/week @ 2024-10-10 708/week @ 2024-10-17 868/week @ 2024-10-24 703/week @ 2024-10-31

4,024 downloads per month
Used in 42 crates (6 directly)

MIT license

1MB
26K SLoC

noodles-bam handles the reading and writing of the BAM (Binary Alignment/Map) file format.

The BAM format contains the same information as SAM (Sequence Alignment/Map), namely a SAM header and a list of records.

Examples

Read all records

use noodles_bam as bam;

let mut reader = bam::io::reader::Builder::default().build_from_path("sample.bam")?;
let header = reader.read_header()?;

for result in reader.records() {
    let record = result?;
    // ...
}

Query records

Querying allows filtering records by region. It requires an associated BAM index (BAI).

use noodles_bam as bam;

let mut reader = bam::io::indexed_reader::Builder::default().build_from_path("sample.bam")?;
let header = reader.read_header()?;

let region = "sq0:5-8".parse()?;
let query = reader.query(&header, &region)?;

for result in query {
    let record = result?;
    // ...
}

Dependencies

~2.8–9MB
~80K SLoC