Adding `bustools` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add bustools

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

bustools = "0.14.0"

The bustools library will be automatically available globally. Read the bustools library documentation.

Back to the crate overview.

Readme

Rustbustools

Rust library to interact with the kallisto/bus format of scRNAseq data (see bustools). At this point, the package is pretty mature, but there might be some minor features missing compared to the original bustools.

There's also a CLI mimicking bustools, see bustools_cli

Examples

For more examples, see the rust-docs.

Iterating a bus file

use bustools::io::{BusReader};
let bus = BusReader::new("/tmp/some.bus");
for record in bus {
    // record.CB, record.UMI ...
}

Iterating a bus file by cell

use bustools::io::BusReader;
use bustools::iterators::CellGroupIterator; //need to bring that trait into scope

let breader = BusReader::new("/path/to/some.bus");
for (cb, vector_of_records) in breader.groupby_cb() {
    // Example: the number of records in that cell
    let n_molecules: usize = vector_of_records.len();
}

Adding bustools library as a dependency

Adding `bustools` library as a dependency