1 Introduction

dittoSeq is a tool built to enable analysis and visualization of single-cell and bulk RNA-sequencing data by novice, experienced, and color-blind coders. Thus, it provides many useful visualizations, which all utilize red-green color-blindness optimized colors by default, and which allow sufficient customization, via discrete inputs, for out-of-the-box creation of publication-ready figures.

For single-cell data, dittoSeq works directly with data pre-processed in other popular packages (Seurat, scater, scran, …). For bulk RNAseq data, dittoSeq’s import functions will convert bulk RNAseq data of various different structures into a set structure that dittoSeq helper and visualization functions can work with. So ultimately, dittoSeq includes universal plotting and helper functions for working with (sc)RNAseq data processed and stored in these formats:

Single-Cell:

Seurat (versions 2 & 3)
SingleCellExperiment

Bulk:

SummarizedExperiment (the general Bioconductor Seq-data storage system)
DESeqDataSet (DESeq2 package output)
DGEList (edgeR package output)

For bulk data, or if your data is currently not analyzed, or simply not in one of these structures, you can still pull it in to the SingleCellExperiment structure that dittoSeq works with using the importDittoBulk function.

1.1 Color-blindness friendliness:

The default colors of this package are red-green color-blindness friendly. To make it so, I used the suggested colors from (Wong 2011) and adapted them slightly by appending darker and lighter versions to create a 24 color vector. All plotting functions use these colors, stored in dittoColors(), by default.

Additionally:

Shapes displayed in the legends are generally enlarged as this can be almost as helpful as the actual color choice for colorblind individuals.
When sensible, dittoSeq functions have a shape.by input for having groups displayed through shapes rather than color. (But note: even as a red-green color impaired individual myself writing this vignette, I recommend using color and I generally only use shapes for showing additional groupings.)
dittoDimPlots can be generated with letters overlaid (set do.letter = TRUE)
The Simulate function allows a cone-typical individual to see what their dittoSeq plots might look like to a colorblind individual.

1.2 Disclaimer

Code used here for dataset processing and normalization should not be seen as a suggestion of the proper methods for performing such steps. dittoSeq is a visualization tool, and my focus while developing this vignette has been simply creating values required for providing visualization examples.

2 Installation

dittoSeq is available through Bioconductor.

# Install BiocManager if needed
if (!requireNamespace("BiocManager", quietly = TRUE))
    install.packages("BiocManager")

# Install dittoSeq
BiocManager::install("dittoSeq")

2.1 Some setup for this vignette that can be ignored

Here, we will need to do some prep as the dataset we will use from Baron et al. (2016) is not normalized nor dimensionality reduced.

library(dittoSeq)
library(scRNAseq)
library(SingleCellExperiment)
library(Seurat)
# Download data
sce <- BaronPancreasData()
# Trim to only 5 of the cell types for simplicity of vignette
sce <- sce[,meta("label",sce) %in% c(
    "acinar", "beta", "gamma", "delta", "ductal")]

Now that we have a single-cell dataset loaded, we are ready to go. All functions work for either Seurat or SCE encapsulated single-cell data.

But to make full use of dittoSeq, we should really have this data log-normalized, and we should run dimensionality reduction and clustering.

# Make Seurat and grab metadata
seurat <- CreateSeuratObject(counts(sce))
seurat <- AddMetaData(seurat, sce$label, col.name = "celltype")
seurat <- AddMetaData(seurat, sce$donor, col.name = "Sample")
seurat <- AddMetaData(seurat,
                      PercentageFeatureSet(seurat, pattern = "^MT"),
                      col.name = "percent.mt")
# Basic Seurat workflow (possibly outdated, but fine for this vignette)
seurat <- NormalizeData(seurat, verbose = FALSE)
seurat <- FindVariableFeatures(object = seurat, verbose = FALSE)
seurat <- ScaleData(object = seurat, verbose = FALSE)
seurat <- RunPCA(object = seurat, verbose = FALSE)
seurat <- RunTSNE(object = seurat)
seurat <- FindNeighbors(object = seurat, verbose = FALSE)
seurat <- FindClusters(object = seurat, verbose = FALSE)

# Grab PCA, TSNE, clustering, log-norm data, and metadata to sce

# sce <- as.SingleCellExperiment(seurat)
# At the time this part of the vignette was made, the above function gave
# warnings. So... manual method
sce <- addDimReduction(
  sce, embeddings = Embeddings(seurat, reduction = "pca"), name = "PCA")
sce <- addDimReduction(
  sce, embeddings = Embeddings(seurat, reduction = "tsne"), name = "TSNE")
sce$idents <- seurat$seurat_clusters
assay(sce, "logcounts") <- GetAssayData(seurat)
sce$percent.mt <- seurat$percent.mt
sce$celltype <- seurat$celltype
sce$Sample <- seurat$Sample

Now that we have a single-cell dataset loaded and analyzed in Seurat, let’s convert it to an SCE for examples purposes.

All functions will work the same for either the Seurat or SCE version.

3 Getting started

3.1 Single-cell RNAseq data

dittoSeq works natively with Seurat and SingleCellExperiment objects. Nothing special is needed. Just load in your data if it isn’t already loaded, then go!

dittoDimPlot(seurat, "Sample")

dittoPlot(seurat, "ENO1", group.by = "celltype")

dittoBarPlot(sce, "celltype", group.by = "Sample")

3.2 Bulk RNAseq data

dittoSeq works natively with bulk RNAseq data stored as a SummarizedExperiment object. For bulk data stored in other forms, namely as a DGEList or as raw matrices, one can use the importDittoBulk() function to convert it into the SingleCellExperiment structure.

Some brief details on this structure: The SingleCellEExperiment class is very similar to the SummarizedExperiment class, just with room added for storing pre-calculated dimensionality reductions.

# First, let's make some mock expression and conditions data
exp <- matrix(rpois(20000, 5), ncol=20)
colnames(exp) <- paste0("sample", seq_len(ncol(exp)))
rownames(exp) <- paste0("gene", seq_len(nrow(exp)))
logexp <- logexp <- log2(exp + 1)

conditions <- factor(rep(1:4, 5))
sex <- c(rep("M", 9), rep("F", 11))

3.2.1 Standard bulk data import workflow, `importDittoBulk()`

Importing bulk data can be accomplished with just the importDittoBulk() function. The function converts various common storage structures for bulk data into the SingleCellExperiment structure.

# Import
myRNA <- importDittoBulk(
    # x can be a DGEList, a DESeqDataSet, a SummarizedExperiment,
    #   or a list of data matrices
    x = list(counts = exp,
             logcounts = logexp),
    # Optional inputs:
    #   For adding metadata
    metadata = data.frame(conditions = conditions,
                          sex = sex),
    #   For adding dimensionality reductions
    reductions = list(pca = matrix(rnorm(20000), nrow=20)))

Metadata and dimensionality reductions can be added either directly within the importDittoBulk() function via the metadata and reductions inputs, respectively, or separately afterwards:

# Add metadata (metadata can alternatively be added in this way)
myRNA$conditions <- conditions
myRNA$sex <- sex

# Add dimensionality reductions (can alternatively be added this way)
# (We aren't actually calculating PCA here.)
myRNA <- addDimReduction(
    object = myRNA,
    embeddings = matrix(rnorm(20000), nrow=20),
    name = "pca",
    key = "PC")

Making plots for bulk data then operates the exact same way as for single-cell.

dittoDimPlot(myRNA, "sex", size = 3, do.ellipse = TRUE)

dittoBarPlot(myRNA, "sex", group.by = "conditions")

dittoBoxPlot(myRNA, "gene1", group.by = "sex")

dittoHeatmap(myRNA, getGenes(myRNA)[1:10],
    annot.by = c("conditions", "sex"))

3.2.1.1 Additional details on bulk data import:

By default, sample-associated data from original objects are retained. But metadata provided to the metadata input will replace any similarly named slots from the original object. The combine_metadata input can additionally be used to turn retention of previous metadata slots off.

DGEList note: The import function attempts to pull in all information stored in common DGEList slots ($counts, $samples, $genes, $AveLogCPM, $common.dispersion, $trended.dispersion, $tagwise.dispersion, and $offset), but any other slots are ignored.

When providing x a list of a single or multiple matrices, it is recommended that matrices containing raw feature counts data be named counts, log-normalized counts data be named logcounts, and otherwise normalized data, be named normcounts. Then you can give the assay input of dittoSeq functions “counts” to point towards the raw data for example. This is not a requirement, but the default assay used in dittoSeq functions will be one of: 1) “logcounts” if it exists, 2) “normcounts” if it exists, 3) “counts” if it exists, or 4) whatever the first assay is in the object.

The SCE object created by importDittoBulk() will contain an internal metadata slot which tells dittoSeq that the object holds bulk data. Knowledge of whether a dataset is single-cell versus bulk is used to aadjust parameter defaults for in few functions; “samples” vs “cells” in the y-axis label of dittoBarPlot(), and whether cells (no) versus samples (yes) should be clustered by default for dittoHeatmap().

4 Helper Functions

dittoSeq’s helper functions make it easy to determine the metadata, gene, and dimensionality reduction options for plotting.

4.1 Metadata

# Retrieve all metadata slot names
getMetas(seurat)

## [1] "orig.ident"      "nCount_RNA"      "nFeature_RNA"    "celltype"       
## [5] "Sample"          "percent.mt"      "RNA_snn_res.0.8" "seurat_clusters"

# Query for the presence of a metadata slot
isMeta("nCount_RNA", seurat)

## [1] TRUE

# Retrieve metadata values:
meta("celltype", seurat)[1:10]

## human1_lib1.final_cell_0001 human1_lib1.final_cell_0002 
##                    "acinar"                    "acinar" 
## human1_lib1.final_cell_0003 human1_lib1.final_cell_0004 
##                    "acinar"                    "acinar" 
## human1_lib1.final_cell_0005 human1_lib1.final_cell_0006 
##                    "acinar"                    "acinar" 
## human1_lib1.final_cell_0007 human1_lib1.final_cell_0008 
##                      "beta"                    "acinar" 
## human1_lib1.final_cell_0009 human1_lib1.final_cell_0010 
##                    "acinar"                    "acinar"

# Retrieve unique values of a metadata
metaLevels("celltype", seurat)

## [1] "acinar" "beta"   "delta"  "ductal" "gamma"

4.2 Genes/Features

# Retrieve all gene names
getGenes(seurat)[1:10]

##  [1] "A1BG"   "A1CF"   "A2M"    "A2ML1"  "A4GALT" "A4GNT"  "AA06"   "AAAS"  
##  [9] "AACS"   "AACSP1"

# Query for the presence of a gene(s)
isGene("CD3E", seurat)

## [1] TRUE

isGene(c("CD3E","ENO1","INS","non-gene"), seurat, return.values = TRUE)

## [1] "CD3E" "ENO1" "INS"

# Retrieve gene expression values:
gene("ENO1", seurat)[1:10]

## human1_lib1.final_cell_0001 human1_lib1.final_cell_0002 
##                   1.8491277                   1.7317730 
## human1_lib1.final_cell_0003 human1_lib1.final_cell_0004 
##                   1.3761065                   1.1225042 
## human1_lib1.final_cell_0005 human1_lib1.final_cell_0006 
##                   2.5082110                   1.5707490 
## human1_lib1.final_cell_0007 human1_lib1.final_cell_0008 
##                   1.9489449                   0.9840699 
## human1_lib1.final_cell_0009 human1_lib1.final_cell_0010 
##                   2.0208192                   1.2962655

4.3 Reductions

# Retrieve all dimensionality reductions
getReductions(seurat)

## [1] "pca"  "tsne"

These are what can be provided to reduction.use for dittoDimPlot().

4.4 Characteristic: Bulk versus single-cell

Because dittoSeq utilizes the SingleCellExperiment structure to handle some bulk RNAseq data, there is a getter and setter for the internal metadata which tells dittoSeq functions which resolution of data a target SCE holds.

# Getter
isBulk(sce)

## [1] FALSE

isBulk(myRNA)

## [1] TRUE

# Setter
mock_bulk <- setBulk(sce) # to bulk
mock_sc <- setBulk(myRNA, set = FALSE) # to single-cell

5 Visualizations

There are many different types of dittoSeq visualizations. Each has intuitive defaults which allow creation of immediately usable plots. Each also has many additional tweaks available through discrete inputs that can help ensure you can create precisely-tuned, deliberately-labeled, publication-quality plots out-of-the-box.

5.1 dittoDimPlot & dittoScatterPlot

These show cells/samples data overlaid on a scatter plot, with the axes of dittoScatterPlot() being gene expression or metadata data and with the axes of dittoDimPlot() being dimensionality reductions like tsne, pca, umap or similar.

dittoDimPlot(seurat, "celltype", reduction.use = "pca")

dittoDimPlot(sce, "ENO1")

dittoScatterPlot(
    object = sce,
    x.var = "PPY", y.var = "INS",
    color.var = "celltype")

dittoScatterPlot(
    object = seurat,
    x.var = "nCount_RNA", y.var = "nFeature_RNA",
    color.var = "percent.mt")

5.1.1 Additional features

Various additional features can be overlaid on top of these plots. Adding each is controlled by an input that starts with add. or do. such as:

do.label
do.ellipse
do.letter
do.contour
do.hover
add.trajectory.lineages
add.trajectory.curves

Additional inputs that apply to and adjust these features will then start with the XXXX part that comes after add.XXXX or do.XXXX, as exemplified below. (Tab-completion friendly!)

A few examples:

dittoDimPlot(seurat, "ident",
             
             do.label = TRUE,
             labels.repel = FALSE,
             
             add.trajectory.lineages = list(
                 c("9","3"),
                 c("8","7","2","4"),
                 c("8","7","1"),
                 c("5","11","6"),
                 c("10","0")),
             trajectory.cluster.meta = "ident")

5.2 dittoDimHex & dittoScatterHex

Similar to the “Plot” versions, these show cells/samples data overlaid on a scatter plot, with the axes of dittoScatterHex() being gene expression or metadata or some other data, and with the axes of dittoDimHex() being dimensionality reductions like tsne, pca, umap or similar.

The plot area is then broken into hexagonal bins and data is presented as summaries of cells/samples within each of those bins.

The minimal functions will summarize density of cells/samples only using color.

dittoDimHex(seurat)

dittoScatterHex(seurat,
    x.var = "PPY", y.var = "INS")

An additional feature can be provided to have that data be summarized in addition to density. Density will then be represented with opacity, while color is used for the additional feature. The color.method input then controls how data within the bins are represented.

NOTE: It is important to note that as soon as differing opacity is added, the color-blindness friendliness of dittoSeq’s default colors is no longer guaranteed.

dittoDimHex(seurat, "INS")

dittoScatterHex(
    object = seurat,
    x.var = "PPY", y.var = "INS",
    color.var = "celltype",
    colors = c(1:4,7), max.density = 15)

5.2.1 Summary function control

color.method controls how data within the bins are represented in colors. It is provided a string, but how that string is utilized depends on the type of target data.

For discrete data, you can provide either "max" (the default) to display the predominant grouping of the bins, or "max.prop" to display the proportion of cells in the bins that belong to the maximal grouping.

For continuous data, any string signifying a function [that summarizes a numeric vector input into with a single numeric value] can be provided. The default is "median", but other useful options are "sum", "mean", "sd", or "mad".

5.2.2 Additional features

Similar to dittoDimPlot and dittoScatterPlot, various additional layers are built in and their addition is controlled by inputs that starts with add. or do. such as:

do.label
do.ellipse
do.contour
add.trajectory.lineages
add.trajectory.curves

Additional inputs that apply to and adjust these features will then start with the XXXX part that comes after add.XXXX or do.XXXX, as exemplified below. (Tab-completion friendly!)

5.3 dittoPlot (and dittoRidgePlot + dittoBoxPlot wrappers)

These display continuous cells/samples’ data on a y-axis (or x-axis for ridgeplots) grouped on the x-axis by sample, age, condition, or any discrete grouping metadata. Data can be represented with violin plots, box plots, individual points for each cell/sample, and/or ridge plots. The plots input controls which data representations are used. The group.by input controls how the data are grouped in the x-axis. And the color.by input controls the colors that fill in violin, box, and ridge plots.

dittoPlot() is the main function, but dittoRidgePlot() and dittoBoxPlot() are wrappers which essentially just adjust the default for the plots input from c(“jitter”, “vlnplot”) to c(“ridgeplot”) or c(“boxplot”,“jitter”), respectively.

dittoPlot(seurat, "ENO1", group.by = "celltype",
    plots = c("vlnplot", "jitter"))

dittoRidgePlot(sce, "ENO1", group.by = "celltype")

dittoBoxPlot(seurat, "ENO1", group.by = "celltype")

5.3.1 Adjustments to data representations

Tweaks to the individual data representation types can be made with discrete inputs, all of which start with the representation types’ name. For example…

dittoPlot(seurat, "ENO1", group.by = "celltype",
    plots = c("jitter", "vlnplot", "boxplot"), # <- order matters
    
    # change the color and size of jitter points
    jitter.color = "blue", jitter.size = 0.5,
    
    # change the outline color and width, and remove the fill of boxplots
    boxplot.color = "white", boxplot.width = 0.1,
    boxplot.fill = FALSE,
    
    # change how the violin plot widths are normalized across groups
    vlnplot.scaling = "count"
    )

5.4 dittoBarPlot

This function displays discrete cells/samples’ data on a y-axis, grouped on the x-axis by sample, age, condition, or any discrete grouping metadata. Data can be represented as percentages or counts, and this is controlled by the scale input.

dittoBarPlot(seurat, "celltype", group.by = "Sample")

dittoBarPlot(seurat, "ident", group.by = "Sample",
    scale = "count")

5.5 dittoHeatmap

This function is essentially a wrapper for generating heatmaps with pheatmap, but with the same automatic, user-friendly, data extraction, (subsetting,) and metadata integration common to other dittoSeq functions.

For large, many cell, single-cell datasets, it can be necessary to turn off clustering by cells in generating the heatmap because the process is very memory intensive. As an alternative, dittoHeatmap offers the ability to order columns in functional ways using the order.by input. This input will default to the first annotation provided to annot.by for single cell datasets, but can also be controlled separately.

# Pick Genes
genes <- c("SST", "REG1A", "PPY", "INS", "CELA3A", "PRSS2", "CTRB1",
    "CPA1", "CTRB2" , "REG3A", "REG1B", "PRSS1", "GCG", "CPB1",
    "SPINK1", "CELA3B", "CLPS", "OLFM4", "ACTG1", "FTL")

# Annotating and ordering cells by some meaningful feature(s):
dittoHeatmap(seurat, genes,
    annot.by = c("celltype", "Sample"))

dittoHeatmap(seurat, genes,
    annot.by = c("celltype", "Sample"),
    order.by = "Sample")

scaled.to.max = TRUE will normalize all expression data to the max expression of each gene [0,1], which is often useful for zero-enriched single-cell data.

show_colnames/show_rownames control whether cell/gene names will be shown. (show_colnames default is TRUE for bulk, and FALSE for single-cell.)

# Add annotations
dittoHeatmap(seurat, genes,
    annot.by = c("celltype", "Sample"),
    scaled.to.max = TRUE,
    show_colnames = FALSE,
    show_rownames = FALSE)

A subset of the supplied genes can be given to the highlight.features input to have names shown for just these genes.

The heatmap can also be rendered by the ComplexHeatmap package, rather than by the pheatmap package (default), by setting complex to TRUE. This package offers a wide variety of distinct plot customization, including rasterization when the heatmap would be too complex for editing software like Illustrator.

# Highlight certain genes
dittoHeatmap(seurat, genes, annot.by = c("celltype", "Sample"),
    highlight.features = genes[1:3],
    complex = TRUE)

Additional tweaks can be added through other built in inputs or by providing additional inputs that get passed along to pheatmap::pheatmap (see ?pheatmap) or to ComplexHeatmap::pheatmap (see ?ComplexHeatmap::pheatmap and ?ComplexHeatmap::Heatmap on which the former function relies.)

5.6 Multi-Plotters

These create either multiple plots or create plots that summarize data for multiple variables all in one plot. They make it easier to create summaries for many genes or many cell types without the need for writing loops.

Some setup for these, let’s roughly pick out the markers of delta cells in this data set

# Idents(seurat) <- "celltype"
# delta.marker.table <- FindMarkers(seurat, ident.1 = "delta")
# delta.genes <- rownames(delta.marker.table)[1:20]
# Idents(seurat) <- "seurat_clusters"

delta.genes <- c(
    "SST", "RBP4", "LEPR", "PAPPA2", "LY6H",
    "CBLN4", "GPX3", "BCHE", "HHEX", "DPYSL3",
    "SERPINA1", "SEC11C", "ANXA2", "CHGB", "RGS2",
    "FXYD6", "KCNIP1", "SMOC1", "RPL10", "LRFN5")

5.6.1 dittoDotPlot

A very succinct representation that is useful for showing differences between groups. The plot uses differently colored and sized dots to summarizes both expression level (color) and percent of cells/samples with non-zero expression (size) for multiple genes (or values of metadata) within different groups of cells/samples.

By default, expression values for all groups are centered and scaled to ensure a similar range of values for all vars displayed and to emphasize differences between groups.

dittoDotPlot(seurat, vars = delta.genes, group.by = "celltype")

dittoDotPlot(seurat, vars = delta.genes, group.by = "celltype",
    scale = FALSE)

5.6.2 multi_dittoPlot & dittoPlotVarsAcrossGroups

multi_dittoPlot() creates dittoPlots for multiple genes or metadata, one plot each.

dittoPlotVarsAcrossGroups() creates a dittoPlot-like representation where instead of representing samples/cells as in typical dittoPlots, each data point instead represents a gene (or metadata). More specifically, the average expression, within each x-grouping, of a gene (or value of a metadata).

multi_dittoPlot(seurat, delta.genes[1:6], group.by = "celltype",
    vlnplot.lineweight = 0.2, jitter.size = 0.3)

dittoPlotVarsAcrossGroups(seurat, delta.genes, group.by = "celltype",
    main = "Delta-cell Markers")

5.6.3 multi_dittoDimPlot & multi_dittoDimPlotVaryCells

multi_dittoDimPlot() creates dittoDimPlots for multiple genes or metadata, one plot each.

multi_dittoDimPlotVaryCells() creates dittoDimPlots for a single gene or metadata, but where distinct cells are highlighted in each plot. The vary.cells.meta input sets the discrete metadata to be used for breaking up cells/samples over distinct plots. This can be useful for checking/highlighting when a gene may be differentially expressed within multiple cell types or across all samples.

The output of multi_dittoDimPlotVaryCells() is similar to that of faceting using dittoDimPlot’s split.by input, but with added capability of showing an “AllCells” plot as well, or of outputting the individual plots for making manually customized plot arrangements when data.out = TRUE.

multi_dittoDimPlot(seurat, delta.genes[1:6])

multi_dittoDimPlotVaryCells(seurat, delta.genes[1],
    vary.cells.meta = "celltype")

6 Customization via Simple Inputs

Many adjustments can be made with simple additional inputs. Here, we go through a few that are consistent across most dittoSeq functions, but there are many more. Be sure to check the function documentation (e.g. ?dittoDimPlot) to explore more!

6.1 Subsetting to certain cells/samples

The cells/samples shown in a given plot can be adjusted with the cells.use input. This can be provided as either a list of cells’ / samples’ names to include, as an integer vector with the indices of cells to keep, or as a logical vector that states whether each cell / sample should be included.

# Original
dittoBarPlot(seurat, "celltype", group.by = "Sample", scale = "count")

# First 10 cells
dittoBarPlot(seurat, "celltype", group.by = "Sample", scale = "count",
    # String method
    cells.use = colnames(seurat)[1:10]
    # Index method, which would achieve the same effect
    # cells.use = 1:10
    )

# Acinar cells only
dittoBarPlot(seurat, "celltype", group.by = "Sample", scale = "count",
    # Logical method
    cells.use = meta("celltype", seurat) == "acinar")

6.2 Faceting with split.by

dittoPlot, dittoDimPlot, and dittoScatterPlots can be split into separate plots for distinct groups of cells with the split.by input.

dittoDimPlot(seurat, "celltype", split.by = "Sample")

dittoDimPlot(seurat, "ENO1", split.by = c("Sample", "celltype"))

6.3 All titles are adjustable.

Relevant inputs are generally main, sub, xlab, ylab, x.labels, and legend.title.

dittoBarPlot(seurat, "celltype", group.by = "Sample",
    main = "Encounters",
    sub = "By Type",
    xlab = NULL, # NULL = remove
    ylab = "Generation 1",
    x.labels = c("Ash", "Misty", "Jessie", "James"),
    legend.title = "Types",
    var.labels.rename = c("Fire", "Water", "Grass", "Electric", "Psychic"),
    x.labels.rotate = FALSE)

As exemplified above, in some functions, the displayed data can be renamed too.

6.4 Colors can be adjusted easily.

Colors are normally set with color.panel or max.color and min.color. When color.panel is used (discrete data), an additional input called colors sets the order in which those are actually used to make swapping around colors easy when nearby clusters appear too similar in tSNE/umap plots!

# original - discrete
dittoDimPlot(seurat, "celltype")

# swapped colors
dittoDimPlot(seurat, "celltype",
    colors = 5:1)

# different colors
dittoDimPlot(seurat, "celltype",
    color.panel = c("red", "orange", "purple", "yellow", "skyblue"))

# original - expression
dittoDimPlot(seurat, "INS")

# different colors
dittoDimPlot(seurat, "INS",
    max.color = "red", min.color = "gray90")

6.5 Underlying data can be output.

Simply add data.out = TRUE to any of the individual plotters and a representation of the underlying data will be output.

dittoBarPlot(seurat, "celltype", group.by = "Sample",
    data.out = TRUE)

## $p

## 
## $data
##     label   grouping count label.count.total     percent
## 1  acinar GSM2230757   110              1386 0.079365079
## 2    beta GSM2230757   872              1386 0.629148629
## 3   delta GSM2230757   214              1386 0.154401154
## 4  ductal GSM2230757   120              1386 0.086580087
## 5   gamma GSM2230757    70              1386 0.050505051
## 6  acinar GSM2230758     3               886 0.003386005
## 7    beta GSM2230758   371               886 0.418735892
## 8   delta GSM2230758   125               886 0.141083521
## 9  ductal GSM2230758   301               886 0.339729120
## 10  gamma GSM2230758    86               886 0.097065463
## 11 acinar GSM2230759   843              2203 0.382660009
## 12   beta GSM2230759   787              2203 0.357240127
## 13  delta GSM2230759   161              2203 0.073082161
## 14 ductal GSM2230759   376              2203 0.170676350
## 15  gamma GSM2230759    36              2203 0.016341353
## 16 acinar GSM2230760     2               941 0.002125399
## 17   beta GSM2230760   495               941 0.526036132
## 18  delta GSM2230760   101               941 0.107332625
## 19 ductal GSM2230760   280               941 0.297555792
## 20  gamma GSM2230760    63               941 0.066950053

For dittoHeatmap, a list of all the arguments that would be supplied to pheatmap are output. This allows users to make their own tweaks to how the expression matrix is represented before plotting, or even to use a different heatmap creator from pheatmap altogether.

dittoHeatmap(seurat, c("SST","CPE","GPX3"), cells.use = colnames(seurat)[1:5],
    data.out = TRUE)

## $mat
##      human1_lib1.final_cell_0001 human1_lib1.final_cell_0002
## SST                     2.726418                   2.7048445
## CPE                     0.000000                   0.5396968
## GPX3                    0.000000                   0.3058240
##      human1_lib1.final_cell_0003 human1_lib1.final_cell_0004
## SST                    2.0163423                    2.474926
## CPE                    0.0000000                    0.000000
## GPX3                   0.4649227                    0.000000
##      human1_lib1.final_cell_0005
## SST                    2.7890247
## CPE                    0.8447536
## GPX3                   0.0000000
## 
## $main
## [1] NA
## 
## $show_colnames
## [1] FALSE
## 
## $show_rownames
## [1] TRUE
## 
## $color
##  [1] "#0000FF" "#0A0AFF" "#1414FF" "#1F1FFF" "#2929FF" "#3434FF" "#3E3EFF"
##  [8] "#4848FF" "#5353FF" "#5D5DFF" "#6868FF" "#7272FF" "#7C7CFF" "#8787FF"
## [15] "#9191FF" "#9C9CFF" "#A6A6FF" "#B0B0FF" "#BBBBFF" "#C5C5FF" "#D0D0FF"
## [22] "#DADAFF" "#E4E4FF" "#EFEFFF" "#F9F9FF" "#FFF9F9" "#FFEFEF" "#FFE4E4"
## [29] "#FFDADA" "#FFD0D0" "#FFC5C5" "#FFBBBB" "#FFB0B0" "#FFA6A6" "#FF9C9C"
## [36] "#FF9191" "#FF8787" "#FF7C7C" "#FF7272" "#FF6868" "#FF5D5D" "#FF5353"
## [43] "#FF4848" "#FF3E3E" "#FF3434" "#FF2929" "#FF1F1F" "#FF1414" "#FF0A0A"
## [50] "#FF0000"
## 
## $cluster_cols
## [1] FALSE
## 
## $border_color
## [1] NA
## 
## $scale
## [1] "row"
## 
## $breaks
## [1] NA
## 
## $legend_breaks
## [1] NA

6.6 plotly hovering can be added.

Many dittoSeq functions can be supplied do.hover = TRUE to have them convert the output into an interactive plotly object that will display additional data about each data point when the user hovers their cursor on top.

Generally, a second input, hover.data, is used to tell dittoSeq what extra data to display. This input takes in a vector of gene or metadata names (or “ident” for Seurat object clustering) in the order you wish for them to be displayed. However, when the types of underlying data possible to be shown are constrained because the plot pieces represent summary data (dittoBarPlot and dittoPlotVarsAcrossGroups), the hover.data input is not used.

# These can be finicky to render in knitting, but still, example code:
dittoDimPlot(seurat, "INS",
    do.hover = TRUE,
    hover.data = c("celltype", "Sample", "ENO1", "ident", "nCount_RNA"))
dittoBarPlot(seurat, "celltype", group.by = "Sample",
    do.hover = TRUE)

6.7 Rasterization / flattening to pixels

Often, single-cell datasets have so many cells that working with plots that show data points for every cell in a vector-based graphics editor, such as Illustrator, becomes prohibitively computationally intensive. In such instances, it can be helpful to have the per-cell graphics layers flattened to a pixel representation. Generally, dittoSeq offers this capability for via do.raster and raster.dpi inputs.

# Note: dpi gets re-set by the styling code of this vignette, so this is
#   just a code example, but the plot won't be quite matched.
dittoDimPlot(sce, "celltype",
    do.raster = TRUE,
    raster.dpi = 300)

For dittoHeatmap(), where the plotting itself is handled externally, the control is a bit different and we rely on ?ComplexHeatmap::Heatmap’s input for this. First, set complex = TRUE to have the heatmap rendered by ComplexHeatmap, then rasterization should be turned on by default when needed, but it can also be turned on manually with use_raster = TRUE.

dittoHeatmap(seurat, genes, scaled.to.max = TRUE,
    complex = TRUE,
    use_raster = TRUE)

7 Session information

sessionInfo()

## R version 4.0.5 (2021-03-31)
## Platform: x86_64-pc-linux-gnu (64-bit)
## Running under: Ubuntu 18.04.5 LTS
## 
## Matrix products: default
## BLAS:   /home/biocbuild/bbs-3.12-bioc/R/lib/libRblas.so
## LAPACK: /home/biocbuild/bbs-3.12-bioc/R/lib/libRlapack.so
## 
## locale:
##  [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C              
##  [3] LC_TIME=en_US.UTF-8        LC_COLLATE=C              
##  [5] LC_MONETARY=en_US.UTF-8    LC_MESSAGES=en_US.UTF-8   
##  [7] LC_PAPER=en_US.UTF-8       LC_NAME=C                 
##  [9] LC_ADDRESS=C               LC_TELEPHONE=C            
## [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C       
## 
## attached base packages:
## [1] parallel  stats4    stats     graphics  grDevices utils     datasets 
## [8] methods   base     
## 
## other attached packages:
##  [1] SeuratObject_4.0.0          Seurat_4.0.1               
##  [3] scRNAseq_2.4.0              SingleCellExperiment_1.12.0
##  [5] SummarizedExperiment_1.20.0 Biobase_2.50.0             
##  [7] GenomicRanges_1.42.0        GenomeInfoDb_1.26.7        
##  [9] IRanges_2.24.1              S4Vectors_0.28.1           
## [11] BiocGenerics_0.36.1         MatrixGenerics_1.2.1       
## [13] matrixStats_0.58.0          dittoSeq_1.2.6             
## [15] ggplot2_3.3.3               BiocStyle_2.18.1           
## 
## loaded via a namespace (and not attached):
##   [1] utf8_1.2.1                    reticulate_1.18              
##   [3] tidyselect_1.1.0              RSQLite_2.2.6                
##   [5] AnnotationDbi_1.52.0          htmlwidgets_1.5.3            
##   [7] grid_4.0.5                    BiocParallel_1.24.1          
##   [9] Rtsne_0.15                    munsell_0.5.0                
##  [11] codetools_0.2-18              ica_1.0-2                    
##  [13] future_1.21.0                 miniUI_0.1.1.1               
##  [15] withr_2.4.1                   colorspace_2.0-0             
##  [17] highr_0.8                     knitr_1.32                   
##  [19] ROCR_1.0-11                   tensor_1.5                   
##  [21] listenv_0.8.0                 labeling_0.4.2               
##  [23] GenomeInfoDbData_1.2.4        polyclip_1.10-0              
##  [25] farver_2.1.0                  bit64_4.0.5                  
##  [27] pheatmap_1.0.12               parallelly_1.24.0            
##  [29] vctrs_0.3.7                   generics_0.1.0               
##  [31] xfun_0.22                     BiocFileCache_1.14.0         
##  [33] R6_2.5.0                      ggbeeswarm_0.6.0             
##  [35] clue_0.3-59                   locfit_1.5-9.4               
##  [37] AnnotationFilter_1.14.0       bitops_1.0-6                 
##  [39] spatstat.utils_2.1-0          cachem_1.0.4                 
##  [41] DelayedArray_0.16.3           assertthat_0.2.1             
##  [43] promises_1.2.0.1              scales_1.1.1                 
##  [45] beeswarm_0.3.1                gtable_0.3.0                 
##  [47] Cairo_1.5-12.2                globals_0.14.0               
##  [49] goftest_1.2-2                 ensembldb_2.14.0             
##  [51] rlang_0.4.10                  GlobalOptions_0.1.2          
##  [53] splines_4.0.5                 rtracklayer_1.50.0           
##  [55] lazyeval_0.2.2                hexbin_1.28.2                
##  [57] spatstat.geom_2.1-0           BiocManager_1.30.12          
##  [59] yaml_2.2.1                    reshape2_1.4.4               
##  [61] abind_1.4-5                   GenomicFeatures_1.42.3       
##  [63] httpuv_1.5.5                  tools_4.0.5                  
##  [65] bookdown_0.21                 ellipsis_0.3.1               
##  [67] spatstat.core_2.0-0           jquerylib_0.1.3              
##  [69] RColorBrewer_1.1-2            ggridges_0.5.3               
##  [71] Rcpp_1.0.6                    plyr_1.8.6                   
##  [73] progress_1.2.2                zlibbioc_1.36.0              
##  [75] purrr_0.3.4                   RCurl_1.98-1.3               
##  [77] prettyunits_1.1.1             rpart_4.1-15                 
##  [79] openssl_1.4.3                 deldir_0.2-10                
##  [81] GetoptLong_1.0.5              pbapply_1.4-3                
##  [83] cowplot_1.1.1                 zoo_1.8-9                    
##  [85] ggrepel_0.9.1                 cluster_2.1.1                
##  [87] magrittr_2.0.1                magick_2.7.1                 
##  [89] data.table_1.14.0             scattermore_0.7              
##  [91] circlize_0.4.12               lmtest_0.9-38                
##  [93] RANN_2.6.1                    ProtGenerics_1.22.0          
##  [95] fitdistrplus_1.1-3            hms_1.0.0                    
##  [97] patchwork_1.1.1               mime_0.10                    
##  [99] evaluate_0.14                 xtable_1.8-4                 
## [101] XML_3.99-0.6                  shape_1.4.5                  
## [103] gridExtra_2.3                 compiler_4.0.5               
## [105] biomaRt_2.46.3                tibble_3.1.0                 
## [107] KernSmooth_2.23-18            crayon_1.4.1                 
## [109] htmltools_0.5.1.1             mgcv_1.8-34                  
## [111] later_1.1.0.1                 tidyr_1.1.3                  
## [113] DBI_1.1.1                     ExperimentHub_1.16.1         
## [115] ComplexHeatmap_2.6.2          dbplyr_2.1.1                 
## [117] MASS_7.3-53.1                 rappdirs_0.3.3               
## [119] Matrix_1.3-2                  igraph_1.2.6                 
## [121] pkgconfig_2.0.3               GenomicAlignments_1.26.0     
## [123] plotly_4.9.3                  spatstat.sparse_2.0-0        
## [125] xml2_1.3.2                    vipor_0.4.5                  
## [127] bslib_0.2.4                   XVector_0.30.0               
## [129] stringr_1.4.0                 digest_0.6.27                
## [131] sctransform_0.3.2             RcppAnnoy_0.0.18             
## [133] spatstat.data_2.1-0           Biostrings_2.58.0            
## [135] rmarkdown_2.7                 leiden_0.3.7                 
## [137] uwot_0.1.10                   edgeR_3.32.1                 
## [139] curl_4.3                      ggplot.multistats_1.0.0      
## [141] shiny_1.6.0                   Rsamtools_2.6.0              
## [143] rjson_0.2.20                  lifecycle_1.0.0              
## [145] nlme_3.1-152                  jsonlite_1.7.2               
## [147] viridisLite_0.4.0             askpass_1.1                  
## [149] limma_3.46.0                  fansi_0.4.2                  
## [151] pillar_1.6.0                  lattice_0.20-41              
## [153] ggrastr_0.2.3                 fastmap_1.1.0                
## [155] httr_1.4.2                    survival_3.2-10              
## [157] interactiveDisplayBase_1.28.0 glue_1.4.2                   
## [159] png_0.1-7                     BiocVersion_3.12.0           
## [161] bit_4.0.4                     stringi_1.5.3                
## [163] sass_0.3.1                    blob_1.2.1                   
## [165] AnnotationHub_2.22.1          memoise_2.0.0                
## [167] dplyr_1.0.5                   irlba_2.3.3                  
## [169] future.apply_1.7.0

References

Baron, Maayan, Adrian Veres, Samuel L. Wolock, Aubrey L. Faust, Renaud Gaujoux, Amedeo Vetere, Jennifer Hyoje Ryu, et al. 2016. “A Single-Cell Transcriptomic Map of the Human and Mouse Pancreas Reveals Inter- and Intra-Cell Population Structure.” Cell Systems 3 (4): 346–360.e4. https://doi.org/10.1016/j.cels.2016.08.011.

Wong, Bang. 2011. “Points of View: Color Blindness.” Nature Methods 8 (6): 441–41. https://doi.org/10.1038/nmeth.1618.

Using dittoSeq to visualize (sc)RNAseq data

October 9th, 2020

Package