A software package for eliminating technical artifacts from high-throughput single-cell RNA sequencing (scRNA-seq) data
Project description
CellBender is a software package for eliminating technical artifacts from high-throughput single-cell RNA sequencing (scRNA-seq) data.
The current release contains the following modules. More modules will be added in the future:
remove-background:
This module removes counts due to ambient RNA molecules and random barcode swapping from (raw) UMI-based scRNA-seq count matrices. At the moment, only the count matrices produced by the CellRanger count pipeline is supported. Support for additional tools and protocols will be added in the future. A quick start tutorial can be found here.
Please refer to the documentation for a quick start tutorial on using CellBender.
Installation and Usage
Manual installation
The recommended installation is as follows. Create a conda environment and activate it:
$ conda create -n cellbender python=3.7
$ source activate cellbender
Install the pytables module:
(cellbender) $ conda install -c anaconda pytables
Install pytorch (shown below for CPU; if you have a CUDA-ready GPU, please skip this part and follow these instructions instead):
(cellbender) $ conda install pytorch torchvision -c pytorch
Clone this repository and install CellBender:
(cellbender) $ pip install -e CellBender
Using The Official Docker Image
A GPU-enabled docker image is available from the Google Container Registry (GCR) as:
us.gcr.io/broad-dsde-methods/cellbender:latest
Terra Users
For Terra users, a workflow is available as:
cellbender/remove-background
Citing CellBender
If you use CellBender in your research (and we hope you will), please consider citing our paper on bioRxiv.
Stephen J Fleming, John C Marioni, and Mehrtash Babadi. CellBender remove-background: a deep generative model for unsupervised removal of background noise from scRNA-seq datasets. bioRxiv 791699; doi: https://doi.org/10.1101/791699
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cellbender-0.2.0.tar.gz.
File metadata
- Download URL: cellbender-0.2.0.tar.gz
- Upload date:
- Size: 54.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
59e47794a3171dbd07c47a5d3d008da51cfd4943c45b010c08ac6f037683d30c
|
|
| MD5 |
ba3ba2a0907a1492c43505ace499e78a
|
|
| BLAKE2b-256 |
df70875716663e93eab9950961c25520a5fb48ee7988b92377dca8b262489c5d
|
File details
Details for the file cellbender-0.2.0-py3-none-any.whl.
File metadata
- Download URL: cellbender-0.2.0-py3-none-any.whl
- Upload date:
- Size: 63.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7875d897b21ade146868eab2a5e1dc1ef0c87d59c517c891a67b56b07932450c
|
|
| MD5 |
2403b6df5772cfbbba57bcdbea1bfc14
|
|
| BLAKE2b-256 |
263a06f6f978d9e124ead57fe6b7ca1abc4370160301bb1cd240f5db3e5adf83
|