knitr::opts_chunk$set( collapse = TRUE, comment = "#>", eval = TRUE ) knitr::opts_knit$set( root.dir = system.file('data', package = 'CHETAH') ) library(Matrix) library(CHETAH)
CHETAH (CHaracterization of cEll Types Aided by Hierarchical classification) is a package for cell type identification of single-cell RNA-sequencing (scRNA-seq) data.
A pre-print of the article describing CHETAH is available at bioRxiv.
Summary: Cell types are assigned by correlating the input data to a reference in a hierarchical manner. This creates the possibility of assignment to intermediate types if the data does not allow to fully classify to one of the types in the reference. CHETAH is built to work with scRNA-seq references, but will also work (with limited capabilities) with RNA-seq or micro-array reference datasets. So, to run CHETAH, you will only need:
SingleCellExperiment
To run chetah on an input count matrix input_counts
with t-SNE^1^ coordinates in input_tsne
, and a reference count matrix ref_counts
with celltypes vector ref_ct
, run:
## Make SingleCellExperiments reference <- SingleCellExperiment(assays = list(counts = ref_counts), colData = DataFrame(celltypes = ref_ct)) input <- SingleCellExperiment(assays = list(counts = input_counts), reducedDims = SimpleList(TSNE = input_tsne)) ## Run CHETAH input <- CHETAHclassifier(input = input, ref_cells = reference) ## Plot the classification PlotCHETAH(input) ## Extract celltypes: celltypes <- input$celltype_CHETAH
A tumor micro-environment reference dataset containing all major cell types for tumor data can be downloaded: here. This reference can be used for all (tumor) input datasets.
CHETAH constructs a classification tree by hierarchically clustering the reference data. The classification is guided by this tree. In each node of the tree, input cells are either assigned to the right, or the left branch. A confidence score is calculated for each of these assignments. When the confidence score for an assignment is lower than the threshold (default = 0.1), the classification for that cell stops in that node.
This results in two types of classifications:
CHETAH will be a part of Bioconductor starting at release 2.9 (30th of April), and will be available by:
## Install BiocManager is neccesary if (!require("BiocManager")) { install.packages("BiocManager") } BiocManager::install('CHETAH') # Load the package library(CHETAH)
The development version can be downloaded from the development version of Bioconductor (in R v3.6).
## Install BiocManager is neccesary if (!require("BiocManager")) { install.packages("BiocManager") } BiocManager::install('CHETAH', version = "devel") # Load the package library(CHETAH)
If you have your data stored as SingleCellExperiments
, continue to the next step.
Otherwise, you need the following data before you begin:
As an example on how to prepare your data, we will use melanoma input data from Tirosh et al. and head-neck tumor reference data from Puram et al. as an example.
## To prepare the data from the package's internal data, run: celltypes_hn <- headneck_ref$celltypes counts_hn <- assay(headneck_ref) counts_melanoma <- assay(input_mel) tsne_melanoma <- reducedDim(input_mel) ## The input data: a Matrix class(counts_melanoma) counts_melanoma[1:5, 1:5] ## The reduced dimensions of the input cells: 2 column matrix tsne_melanoma[1:5, ] all.equal(rownames(tsne_melanoma), colnames(counts_melanoma)) ## The reference data: a Matrix class(counts_hn) counts_hn[1:5, 1:5] ## The cell types of the reference: a named character vector str(celltypes_hn) ## The names of the cell types correspond with the colnames of the reference counts: all.equal(names(celltypes_hn), colnames(counts_melanoma))
SingleCellExperiments
{#sce}CHETAH expects data to be in the format of a SingleCellExperiment
,
which is an easy way to store different kinds of data together.
Comprehensive information on this data type can be found here.
A SingleCellExperiment
holds three things:
assays
list
of Matrices
colData
DataFrames
ReducedDims
SimpleList
of 2-column data.frames
or matrices
CHETAH needs
SingleCellExperiment
with:SingleCellExperiment
with:For the example data, we would make the two objects by running:
## For the reference we define a "counts" assay and "celltypes" metadata headneck_ref <- SingleCellExperiment(assays = list(counts = counts_hn), colData = DataFrame(celltypes = celltypes_hn)) ## For the input we define a "counts" assay and "TSNE" reduced dimensions input_mel <- SingleCellExperiment(assays = list(counts = counts_melanoma), reducedDims = SimpleList(TSNE = tsne_melanoma))
Now that the data is prepared, running chetah is easy:
input_mel <- CHETAHclassifier(input = input_mel, ref_cells = headneck_ref)
CHETAH returns the input object, but added:
int_colData
and int_metadata
, not meant for direct interaction, butPlotCHETAH
and CHETAHshiny
CHETAH's classification can be visualized using: PlotCHETAH
.
This function plots both the classification tree and the t-SNE (or other provided reduced dimension) map.
Either the final types or the intermediate types are colored in these plots. The non-colored types are represented in a grayscale.
To plot the final types:
PlotCHETAH(input = input_mel)
Conversely, to color the intermediate types:
PlotCHETAH(input = input_mel, interm = TRUE)
If you would like to use the classification, and thus the colors, in another package (e.g. Seurat^2^), you can extract the colors using:
colors <- PlotCHETAH(input = input_mel, return_col = TRUE)
CHETAHshiny
The classification of CHETAH and other outputs like profile and confidence scores can be visualized in a shiny application that allows for easy and interactive analysis of the classification.
Here you can view:
The following command will open the shiny application as in an R window. The page can also be opened in your default web-browser by clicking "Open in Browser" at the very top.
CHETAHshiny(input = input_mel)
CHETAH calculates a confidence score for each assignment of an input cell to one of the branches of a node.
The confidence score:
The default confidence threshold of CHETAH is 0.1.
This means that whenever a cell is assigned to a branch and the confidence of that assignment is lower than 0.1, the classification will stop in that node.
The confidence threshold can be adjusted in order to classify more or fewer cells to a final type:
For example, to only classify cells with very high confidence:
input_mel <- Classify(input = input_mel, 0.8) PlotCHETAH(input = input_mel, tree = FALSE)
Conversely, to classify all cells:
input_mel <- Classify(input_mel, 0) PlotCHETAH(input = input_mel, tree = FALSE)
For renaming types in the tree, CHETAH comes with the RenameBelowNode
function.
This can be interesting when you are more interested in the general types, type in the different intermediate and final types.
For the example data, let's say that we are not interested in all the different subtypes of T-cells (under Node6 and Node7), we can name all these cells "T cells" by running:
input_mel <- RenameBelowNode(input_mel, whichnode = 6, replacement = "T cell") PlotCHETAH(input = input_mel, tree = FALSE)
To reset the classification to its default, just run Classify
again:
input_mel <- Classify(input_mel) ## the same as Classify(input_mel, 0.1) PlotCHETAH(input = input_mel, tree = FALSE)
SingleCellExperiment
object, as explained aboveCHETAH can use any scRNA-seq reference, but the used reference greatly influences the classification.
The following general rules apply on choosing and creating a reference:
CHETAH does not require normalized input data, but the reference data has to be normalized beforehand. The reference data that is used in this vignette is already normalized. Only for sake of the example, we use this dataset anyway to perform nomalization:
assay(headneck_ref, "counts") <- apply(assay(headneck_ref, "counts"), 2, function(column) log2((column/sum(column) * 100000) + 1))
Certainly with reference with relatively high drop-out rates, CHETAH can be influenced by highly expressed, and thus highly variable, genes. In our experience, mainly ribosomal protein genes can cause such an effect. We therefore delete these genes, using the "ribosomal" list from here
ribo <- read.table("~/ribosomal.txt", header = FALSE, sep = '\t') headneck_ref <- headneck_ref[!rownames(headneck_ref) %in% ribo[,1], ]
The performance of CHETAH is heavily dependent on the quality of the reference.
The quality of the reference is affected by:
To see how well CHETAH can distinguish between the cell types in a reference,
CorrelateReference
and more importantly ClassifyReference
can be run.
CorrelateReference
is a function that, for every combination of two cell types, finds the
genes with the highest fold-change between the two and uses these to correlate them to each other.
If the reference is good, all types will correlate poorly or even better, will anti-correlate.
CorrelateReference(ref_cells = headneck_ref)
In this case, most cell types will be distinguishable: many types don't correlate, or anti-correlate. However, some types are quite similar. Regulatory and CD4 T cells, or CD4 and CD8 T cells, might be hard to distinguish in the input data.
Another check to see whether CHETAH can distinguish between the cell types in the reference is
ClassifyReference
. This function uses the reference to classify the reference itself.
If CHETAH works well with the reference, there should be almost no mix-ups in the classification, i.e.
all cells of type A should be classified to type A.
ClassifyReference(ref_cells = headneck_ref)
In this reference, there is never more than 10% mix-up between two cell types. In addition, a low percentage of cells is classified as an intermediate type. Most mix-ups occur between subtypes of T cells. In this case the user should be aware that these cell type labels have the highest chance to interchange.
CHETAH is optimized to give good results in most analyses, but it can happen that a classification is imperfect.
When CHETAH does not give the desired output (too little cells are classified, visually random classification, etc),
These are the following steps to take (in this order):
input[!(grepl("^RP", rownames(input))), ]
is an imperfect, but very quick way to do this.n_genes
parameter).
^1^ Van Der Maaten and Hinton (2008). Visualizing high-dimensional data using t-sne. J Mach Learn Res. 9: 2579-2605. doi: 10.1007/s10479-011-0841-3.
^2^ Satija et al. (2015) Spatial reconstruction of single-cell gene expression data. Nat Biotechnol. 33(5):495-502. May 2015. doi: 10.1038/nbt.3192. More information at: https://satijalab.org/seurat/
^3^ Picelli et al. (2013) Smart-seq2 for sensitive full-length transcriptome profiling in single cells. Nat Methods. 10(11): 1096-1100. doi: 10.1038/nmeth.2639.
sessionInfo()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.