Skip to main content

Method to detect and enable removal of doublets from single-cell RNA-sequencing.

Project description

DoubletDetection

DOI Documentation Status Code style: black Build Status

DoubletDetection is a Python3 package to detect doublets (technical errors) in single-cell RNA-seq count matrices.

Installing DoubletDetection

Install from PyPI

pip install doubletdetection

Install from source

git clone https://github.com/JonathanShor/DoubletDetection.git
cd DoubletDetection
pip3 install .

If you are using pipenv as your virtual environment, it may struggle installing from the setup.py due to our custom Phenograph requirement. If so, try the following in the cloned repo:

pipenv run pip3 install .

Running DoubletDetection

To run basic doublet classification:

import doubletdetection
clf = doubletdetection.BoostClassifier()
# raw_counts is a cells by genes count matrix
labels = clf.fit(raw_counts).predict()
# higher means more likely to be doublet
scores = clf.doublet_score()
  • raw_counts is a scRNA-seq count matrix (cells by genes), and is array-like
  • labels is a 1-dimensional numpy ndarray with the value 1 representing a detected doublet, 0 a singlet, and np.nan an ambiguous cell.
  • scores is a 1-dimensional numpy ndarray representing a score for how likely a cell is to be a doublet. The score is used to create the labels.

The classifier works best when

  • There are several cell types present in the data
  • It is applied individually to each run in an aggregated count matrix

In v2.5 we have added a new experimental clustering method (scanpy's Louvain clustering) that is much faster than phenograph. We are still validating results from this new clustering. Please see the notebook below for an example of using this new feature.

Tutorial

See our jupyter notebook for an example on 10k PBMCs from 10x Genomics.

Obtaining data

Data can be downloaded from the 10x website.

Credits and citations

Gayoso, Adam, Shor, Jonathan, Carr, Ambrose J., Sharma, Roshan, Pe'er, Dana (2020, December 18). DoubletDetection (Version v3.0). Zenodo. http://doi.org/10.5281/zenodo.2678041

We also thank the participants of the 1st Human Cell Atlas Jamboree, Chun J. Ye for providing data useful in developing this method, and Itsik Pe'er for providing guidance in early development as part of the Computational genomics class at Columbia University.

This project is licensed under the terms of the MIT license.

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

doubletdetection-4.0.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

doubletdetection-4.0-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file doubletdetection-4.0.tar.gz.

File metadata

  • Download URL: doubletdetection-4.0.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.6 Darwin/21.3.0

File hashes

Hashes for doubletdetection-4.0.tar.gz
Algorithm Hash digest
SHA256 8896e4be646075388f68d4e4ca5127e8fe0ac3d79cd5a6025cd2c9ec7b509661
MD5 f0fd4718d203163aae37227f74431c7a
BLAKE2b-256 cb68f7fba4f3712b46914f969fa81e6ce8f18f854bcade8a4705f4a090d64544

See more details on using hashes here.

File details

Details for the file doubletdetection-4.0-py3-none-any.whl.

File metadata

  • Download URL: doubletdetection-4.0-py3-none-any.whl
  • Upload date:
  • Size: 11.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.6 Darwin/21.3.0

File hashes

Hashes for doubletdetection-4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0179ab4e77ea66cb1ab1dd7d63a3b38643941e70b5082bf9922dd40d8d0063b0
MD5 93d53bd035657d8f42e7e1e1413c7171
BLAKE2b-256 515fae88b912af8d517066fa2013819a53372e6923ec75d2f202b0d3a1da8871

See more details on using hashes here.

Supported by

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