Python wrapper around kallisto | bustools for scRNA-seq analysis
Project description
kb-python
kb-python is a python package that wraps the kallisto | bustools single-cell RNA-seq workflow [1]. It was developed by Kyung Hoi (Joseph) Min and A. Sina Booeshaghi.
The wrapper simplifies downloading and running of the kallisto
[1] and bustools [2] programs. It was inspired by Sten Linnarsson’s loompy fromfq
command (http://linnarssonlab.org/loompy/kallisto/index.html)
The kb
program consists of two parts:
The kb ref
command builds or downloads a species-specific index for
pseudoalignment of reads. This command must be run prior to kb count
, and it
runs the kallisto index
[1].
The kb count
command runs the kallisto [1] and bustools [2] programs. It can
be used for pre-processing of data from a variety of single-cell RNA-seq
technologies, and for a number of different workflows (e.g. production of gene
count matrices, RNA velocity analyses, etc.). The output can be saved in a
variety of formats including mtx and loom.
If you use kb
we ask that you cite the following two papers:
[1] Bray, N. L., Pimentel, H., Melsted, P., & Pachter, L. (2016). Near-optimal probabilistic RNA-seq quantification. Nature biotechnology, 34(5), 525.
[2] Melsted, P., Booeshaghi, A. S., Gao, F., da Veiga Beltrame, E., Lu, L., Hjorleifsson, K. E., Gehring, J., & Pachter, L. (2019). Modular and efficient pre-processing of single-cell RNA-seq. BioRxiv, 673285.
Prerequisites
None. The kallisto and bustools binaries are included with the package.
Getting Started
Visit the Getting Started tutorial on Google Colab.
Documentation
- User documentation and tutorials are available here.
- Developer documentation is hosted on Read the Docs.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for kb_python-0.25.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 74fa467a8bcca036a3b89fc1516fca5fbf57d5e4d32c151a0125c69d8c8a0f77 |
|
MD5 | 432b9cb90dbeb82b5f6a7f0b254c6e2b |
|
BLAKE2b-256 | 5cd4263606724d49c4fe2a765d2a48221a90d1d88403f827ce0fdafe1810a40d |