Skip to main content

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 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 mix and loom. Examples are provided below.

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

Source Distribution

kb_python-0.24.0.tar.gz (35.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kb_python-0.24.0-py3-none-any.whl (35.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kb_python-0.24.0.tar.gz
  • Upload date:
  • Size: 35.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.5

File hashes

Hashes for kb_python-0.24.0.tar.gz
Algorithm Hash digest
SHA256 7054c04432f47717702aee4d2fbbaf24a675e38c0816fdcce4709db7ab2cde99
MD5 344c2ff6a66fb6a4ddef4e0e11f9d3a9
BLAKE2b-256 6edbf8783d41f6b961740ae9ed932caf9a13cf74bbd87adc060cbe48b92acc49

See more details on using hashes here.

File details

Details for the file kb_python-0.24.0-py3-none-any.whl.

File metadata

  • Download URL: kb_python-0.24.0-py3-none-any.whl
  • Upload date:
  • Size: 35.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.5

File hashes

Hashes for kb_python-0.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b48fdafe8e0fd75ab05931b368f001aec29327aaea8a7674f0b567b0424f883e
MD5 db04052c85a2bb582e95d5442c5d7239
BLAKE2b-256 116e3fb32cd3379de065b994dd83d5cfb03fb7330d27d9a0ad32502f07e3955b

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