Skip to main content

Python wrapper around kallisto | bustools for scRNA-seq analysis

Project description

kb-python

github version pypi version python versions status codecov pypi downloads docs license

kb-python is a python package that wraps the kallisto | bustools single-cell RNA-seq workflow [2]. 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., Liu, L., Gao, F., Lu, L., Min, K. H., da Veiga Beltrame, E., Hjorleifsson, K. E., Gehring, J., & Pachter, L. (2021). Modular and efficient pre-processing of single-cell RNA-seq. Nature Biotechnology.

Prerequisites

None. The kallisto and bustools binaries are included with the package.

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.

Source Distribution

kb_python-0.27.1.tar.gz (7.5 MB view details)

Uploaded Source

File details

Details for the file kb_python-0.27.1.tar.gz.

File metadata

  • Download URL: kb_python-0.27.1.tar.gz
  • Upload date:
  • Size: 7.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.7.12

File hashes

Hashes for kb_python-0.27.1.tar.gz
Algorithm Hash digest
SHA256 754663be93e284225fab283b05ad137d6a9adf281bfa5edc6f77a6a68d445042
MD5 08efc45865263144fd6d4e9d8aaba677
BLAKE2b-256 cfc13c194503f9546a2181929291e63a597f0f306c15e6f849a12ef9742b88e0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page