Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 2.98 KB

README.md

File metadata and controls

42 lines (31 loc) · 2.98 KB
Raw

scDREAMER

Overview

scDREAMER is a single-cell data integration framework that employs a novel adversarial variational autoencoder for learning lower-dimensional cellular embeddings and a batch classifier neural network for the removal of batch effects. The jupyter notebooks for reproducibility of results in the manuscript are available at https://github.com/Zafar-Lab/scDREAMER-reproducibility. See our paper below for more details. DOI: https://doi.org/10.1038/s41467-023-43590-8

Installation

A stable pip installation release for scDREAMER package will be made available shortly. For now, we recommend users to directly clone our stable main branch and set scDREAMER as the working directory. Creating conda environment using ./ENVIRONMENTS/scDREAMER.yml will install all the dependent packages and libraries. scDREAMER can be set up as follows

git clone https://github.com/Zafar-Lab/scDREAMER.git
cd scDREAMER/Environments
conda env create -f scDREAMER.yml
conda activate scdreamer

What Computational tasks can scDREAMER be used for?

scDREAMER suite can be used for:

  1. scDREAMER for an unsupervised integration of multiple batches
  2. scDREAMER-SUP for a supervised integration across multiple batches
  3. scDREAMER-SUP can also be when cell type annotations are missing in the datasets i.e., 10%, 20%, 50%
  4. Atlas level and cross-species integration
  5. Large datasets with ~1 million cells

Tutorials

Check out the following Colab notebook to get a flavor of a typical workflow for data integration using scDREAMER and scDREAMER-SUP (Link to Datasets) below.

  1. scDREAMER applied to human immune integration task
  2. scDREMER-SUP applied to human immune cells integration task
  3. scDREAMER-SUP applied to human immune cells integration task under 50% missing cell labels setting

Documentation

Read the docs: https://scdreamer.readthedocs.io/en/latest/

Contributing

In case of any bug reports, enhancement requests, general questions, and other contributions, please create an issue. For more substantial contributions, please fork this repo, push your changes to your fork, and submit a pull request with a good commit message.

Cite this article

Ajita Shree*, Musale Krushna Pavan*, and Hamim Zafar. "scDREAMER for atlas-level integration of single-cell datasets using deep generative model paired with adversarial classifier." Nature Communications 14.1 (2023): 7781. doi: https://doi.org/10.1038/s41467-023-43590-8
* equally contributed