How to install the bustools_cli crate // Lib.rs

bustools_cli is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install bustools_cli

It will make the bustools_cli command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall bustools_cli uninstalls.

Adding `bustools_cli` library as a dependency

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

cargo add bustools_cli

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

bustools_cli = "0.6.0"

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

Back to the crate overview.

Readme

Rust version of bustools command line interface. Built on the bustools_core library crate.

Example

# sorting
rustbustools --output /tmp/sorted.bus sort --ifile /tmp/unsorted.bus

# correcting CBs
rustbustools --output /tmp/corrected.bus sort --ifile /tmp/sorted.bus --whitelist /tmp/10x_whitelist.txt

# inspecting
rustbustools --output /dev/null --ifile /tmp/sorted.bus

# count
rustbustools --output /tmp/count_folder --ifile /tmp/sorted.bus --t2g /tmp/transcripts_to_gene.txt

# compression
# -N is the chunksize of a busz block
rustbustools --output /tmp/compressed.busz -i /tmp/sorted.bus -N 10000

# decompression
rustbustools --output /tmp/plain.bus -i /tmp/compressed.busz

Installing the command-line executable

Adding bustools_cli library as a dependency

Adding `bustools_cli` library as a dependency