cellassign automatically assigns single-cell RNA-seq data to known cell types across thousands of cells accounting for patient and batch specific effects. Information about a priori known markers cell types is provided as input to the model in the form of a (binary) marker gene by cell-type matrix. cellassign then probabilistically assigns each cell to a cell type, removing subjective biases from typical unsupervised clustering workflows.
Getting started
Installation
Installing from GitHub
cellassign is built using Google’s Tensorflow, and as such requires installation of the R package tensorflow:
install.packages("tensorflow")
tensorflow::install_tensorflow(extra_packages='tensorflow-probability', version = "2.1.0")
Please ensure this installs version 2 of tensorflow. You can check this by calling
Please note that the ‘cellassign’ project is released with a
Contributor Code of Conduct.
By contributing to this project, you agree to abide by its terms.
cellassign
cellassignautomatically assigns single-cell RNA-seq data to known cell types across thousands of cells accounting for patient and batch specific effects. Information about a priori known markers cell types is provided as input to the model in the form of a (binary) marker gene by cell-type matrix.cellassignthen probabilistically assigns each cell to a cell type, removing subjective biases from typical unsupervised clustering workflows.Getting started
Installation
Installing from GitHub
cellassignis built using Google’s Tensorflow, and as such requires installation of the R packagetensorflow:Please ensure this installs version 2 of tensorflow. You can check this by calling
cellassigncan then be installed from github:Installing from conda
With conda, install the current release version of
cellassignas follows:Documentation
Package documentation can be found here. This includes the following vignettes:
Assigning single-cells to known cell types with CellAssign
Constructing marker genes from purified bulk/scRNA-seq data
Basic usage
cellassignrequires the following inputs:exprs_obj: Cell-by-gene matrix of raw counts (or SingleCellExperiment withcountsassay)marker_gene_info: Binary gene-by-celltype marker gene matrix or list relating cell types to marker geness: Size factorsX: Design matrix for any patient/batch specific effectsThe model can be run as follows:
An example set of markers for the human tumour microenvironment can be loaded by calling
Please see the package vignette for details and caveats.
Paper
Probabilistic cell-type assignment of single-cell RNA-seq for tumor microenvironment profiling, Nature Methods 2019
Code of Conduct
Please note that the ‘cellassign’ project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
Authors
Allen W Zhang, University of British Columbia
Kieran R Campbell, University of British Columbia