Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python wrapper around kallisto | bustools for scRNA-seq analysis

Project description

kb-python

github version pypi version python versions status pypi downloads docs license

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 page.

Documentation

  • User documentation and tutorials are available here.
  • Developer documentation is hosted on Read the Docs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for kb-python, version 0.24.4
Filename, size File type Python version Upload date Hashes
Filename, size kb_python-0.24.4-py3-none-any.whl (35.4 MB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size kb_python-0.24.4.tar.gz (35.3 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page