Overview

The primary utility of the spatialHeatmap package is the generation of spatial heatmaps (SHMs) for visualizing cell-, tissue- and organ-specific abundance patterns of biological molecules (e.g. RNAs) in spatial anatomical images (Zhang et al. 2024). This is useful for identifying biomolecules with spatially enriched/depleted abundance patterns as well as clusters and/or network modules composed of biomolecules sharing similar abundance patterns such as similar gene expression patterns. These functionalities are introduced in the main vignette of this package. The following describes extended functionalities for integrating tissue with single-cell data by co-visualizing them in composite plots that combine SHMs with embedding plots of high-dimensional data. The resulting spatial context information is important for gaining insights into the tissue-level organization of single cell data or vice versa.

Data Structures

The supported bulk and single-cell assay data come from most large-scale profiling technologies such as transcriptomics, proteomics, metabolomics, etc, while the corresponding anatomical images need to be supplied as annotated SVG (aSVG) images, where spatial features (e.g. tissues) are assigned unique identifiers.

To implement the co-visualization functionality, spatialHeatmap takes advantage of efficient and reusable S4 classes for both assay data and aSVGs respectively. The former includes the Bioconductor core data structures SummarizedExperiment (SE, Morgan et al. (2018)) and SingleCellExperiment (SCE, Amezquita et al. (2020)) for bulk and single-cell data respectively (Figure @ref(fig:datastr)A, C). The slots assays, colData, and rowData contain expression values, tissue/cell metadata, and biomolecule metadata respectively. For the embedding plots of single-cell data, the reduced dimensionality embedding results (PCA, UMAP or tSNE) are stored in the reducedDims slot of SCE.

The S4 class SVG (Figure @ref(fig:datastr)B) is developed specifically in spatialHeatmap for storing aSVG instances. The two most important slots coordinate and attribute stores the aSVG feature coordinates and respective attributes (colors, line withs, etc) respectively, while other slots dimension, svg, and raster stores image dimension, original aSVG instances, and raster image paths respectively. Moreover, the meta class SPHM (Figure @ref(fig:datastr)D) is developed to harmonize these data objects.

When creating co-visualization plots (Figure @ref(fig:datastr)a-b), SHMs are created by mapping expression values from SE to corresponding spatial features in SVG through the same identifiers (here TissuesA and TissueB) between the two, and single cells in SCE are associated with spatial features through their group labels (here TissuesA and TissueB) stored in the colData slot.

Schematic view of data structures and creation of co-visualization plots. File imports, classes, and plotting functionalities are illustrated in boxes with color-coded title bars in grey, blue and green, respectively. Quantitative and experimental design data (I) are imported into matching slots of an SE container (A). aSVG image files are stored in SVG containers (B). Expression profiles of a chosen gene (GeneX) in (A) are mapped to the corresponding spatial features in (B) via common identifiers (here TissuesA and TissueB). The quantitative data is represented in the matching features by colors according to a number to color key and the output is an SHM (a). For co-visualization plots, single-cell data are stored in the SCE object class (C). Reduced dimension data for embedding plots can be generated in R or imported from files. The single-cell embedding results are co-visualized with SHMs where the cell-to-tissue mappings are indicated by common colors in the co-visualization plot (b). The SPHM meta class organizes the individual objects (A)-(C) along with internally generated data.

Cell-Tissue Mapping and Coloring

To co-visualize bulk and single-cell data (Figure @ref(fig:datastr)b), the individual cells of the single-cell data are mapped via their group labels to the corresponding tissue features in an aSVG image. For handling cell grouping information, five major methods are supported including (1) existing annotation labels, (2) manual assignments, (3) marker genes, (4) clustering labels, and (5) automated co-clustering (Figure @ref(fig:grpcolor)a). In the annotation method, existing group labels are available and can be uploaded and/or stored in the SCE object, such as the SCE instances in the scRNAseq package (Risso and Cole 2022). The manual method allows users to create cell-tissue associations one-by-one or import them from a tabular file. The marker-gene method utilizes known marker genes to group cells. In the clustering method, cells are clustered and grouped by clustering labels. In contrast, the automated co-clustering aims to assign source tissues to corresponding single cells computationally by a co-clustering method (Figure @ref(fig:coclusOver)). This method is experimental and requires bulk expression data that are obtained from the tissues represented in the single-cell data.

The matching between cell groups in the embedding plots and tissue features in SHMs are indicated with four coloring schemes (Figure @ref(fig:grpcolor)b). The first three ‘fixed-group’, ‘cell-by-group’, and ‘feature-by-group’ assign the same color for a cell group and matching tissue. The main difference is that ‘fixed-group’ uses constance colors while the latter two uses heat colors that is proportional to the numeric expression information obtained from the single cell or bulk expression data of a chosen gene. When expression values among groups are very similar, toggling between the constant and heat colors is important to track the tissue origin in the single cell data. In ‘cell-by-group’ coloring, expression values of a given gene within each cell group are summarized by mean or median, then heat colors are created from the summary values and assigned to the corresponding cells and tissues (Figure @ref(fig:grpcolor).1-2). In this case, the mapping direction is cell-to-tissue. The ‘feature-by-group’ coloring is similar except that heat colors are based on summary values of each tissue, and the mapping direction is tissue-to-cell. The most meaningful coloring is ‘cell-by-value’ (Figure @ref(fig:grpcolor).2-3). In this option, each cell and tissue is colored independently according to respective expression values of a chosen gene, so the cellular heterogeneity is reflected.

Similar to other functionalities in spatialHeatmap, these functionalities are available within R as well as the corresponding Shiny App (Chang et al. 2021).

Cell grouping and coloring. (a) For co-visualizing with SHMs, single cells need to have group labels. Five methods are supported to obtain group labels. (b) In the co-visualization plot, matching between cells and aSVG features is indicated by colors between the two. Four coloring options are summarized in a table. The cell grouping and coloring are schematically illustrated in 1-3.

Installation

The spatialHeatmap package can be installed with the BiocManager::install command.

if (!requireNamespace("BiocManager", quietly = TRUE))
    install.packages("BiocManager")
BiocManager::install("spatialHeatmap")

Packages and Documentation

Next, the packages required for running the sample code in this vignette need to be loaded.

library(spatialHeatmap); library(SummarizedExperiment); library(ggplot2); library(SingleCellExperiment);
library(kableExtra); library(Seurat)

The following lists the vignette(s) of this package in an HTML browser. Clicking the name of the corresponding vignette will open it.

browseVignettes('spatialHeatmap')

To reduce runtime, intermediate results can be cached under ~/.cache/shm.

cache.pa <- '~/.cache/shm' # Set path of the cache directory

Annotation Labels

To obtain reproducible results, a fixed seed is set for generating random numbers.

set.seed(10)

This section demonstrates the co-visualization plots created with annotation labels and ‘feature-by-group’ coloring. The single-cell data are stored in an SCE object downloaded from the scRNAseq package (Risso and Cole 2022), which is the same as the Quick Start (sce). The annotation labels are stored in the label column of the colData slot and partially shown below.

colData(sce)[1:3, 1:2]

## DataFrame with 3 rows and 2 columns
##                              label         age
##                        <character> <character>
## C1.1772096.085.B10          SN.VTA         p19
## C1.1772125.088.G02 corpus.callosum         p22
## C1.1772099.084.C06    zona.incerta         p19

The bulk RNA-seq data are modified from a research on mouse cerebellar development (Vacher et al. 2021) and are imported in an SE object, which are partially shown below. Note, replicates are indicated by the same tissue names (e.g. cerebral.cortex).

blk.mus.pa <- system.file("extdata/shinyApp/data", "bulk_mouse_cocluster.rds", package="spatialHeatmap") 
blk.mus <- readRDS(blk.mus.pa)
assay(blk.mus)[1:3, 1:5]

##          cerebral.cortex hippocampus hypothalamus cerebellum cerebral.cortex
## AI593442             177         256           50         24             285
## Actr3b               513        1465          228        244             666
## Adcy1                701        1243           57       1910             836

colData(blk.mus)[1:3, , drop=FALSE]

## DataFrame with 3 rows and 1 column
##                          tissue
##                     <character>
## cerebral.cortex cerebral.cortex
## hippocampus         hippocampus
## hypothalamus       hypothalamus

Bulk and single cell data are jointly normalized and subsequently separated.

mus.ann.nor <- read_cache(cache.pa, 'mus.ann.nor') 

## No valid record is detected for mus.ann.nor !

if (is.null(mus.ann.nor)) {
  # Joint normalization.
  mus.lis.nor <- norm_cell(sce=sce, bulk=blk.mus, quick.clus=list(min.size = 100, d=15), com=FALSE)
  save_cache(dir=cache.pa, overwrite=TRUE, mus.ann.nor)
}

## Cache directory: ~/.cache/shm

## [1] "~/.cache/shm"

# Separate bulk and cell data.
blk.mus.nor <- mus.lis.nor$bulk
cell.mus.nor <- mus.lis.nor$cell
colData(cell.mus.nor) <- colData(sce)

In normalized single-cell data, dimension reductions are performed with PAC, UMAP, and TSNE methods respectively, then single cells are plotted at the TSNE dimensions, where cells are represented by dots and are colored by the annotation labels (color.by="label").

cell.dim <- reduce_dim(cell.mus.nor, min.dim=5)

## "prop" is set 1 in "getTopHVGs" due to too less genes.

plot_dim(cell.dim, color.by="label", dim='UMAP')

Embedding plot of single-cell data. The cells (dots) are colored by the grouping information stored in the colData slot of the corresponding SCE object

In normalized bulk data, expression values for each gene are summarized by mean across tissue replicates (here aggr='mean').

# Aggregation.
blk.mus.aggr <- aggr_rep(blk.mus.nor, sam.factor='sample', aggr='mean')
assay(blk.mus.aggr)[1:2, ]

The aSVG instance of mouse brain from the Quick Start is used. Partial of the aSVG features are shown.

tail(attribute(svg.mus.brain)[[1]])[1:3, 1:4]

## # A tibble: 3 × 4
##   feature                      id             fill  stroke
##   <chr>                        <chr>          <chr>  <dbl>
## 1 brainstem                    UBERON_0002298 none    0.05
## 2 midbrain                     UBERON_0001891 none    0.05
## 3 dorsal.plus.ventral.thalamus UBERON_0001897 none    0.05

Following the same conventions in the main vignette, at least one tissue in bulk data should have the same identifier with an aSVG feature so as to create SHM.

colnames(blk.mus) %in% attribute(svg.mus.brain)[[1]]$feature

##  [1] TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE

Same with the Quick Start, a translation list is used to match cell group and tissue labels. In ‘feature-by-group’ coloring, the feature and cell labels should be be the names and corresponding elements of the list, respectively.

lis.match.blk <- list(cerebral.cortex=c('cortex.S1'), hypothalamus=c('corpus.callosum', 'hypothalamus'))

The following plots the corresponding co-visualization for sample gene ‘Cacnb4’. The legend under the embedding plot shows the cell labels in the matching list (lis.match.blk). The source tissue information is indicated by using the same colors in the embedding and SHM plots on the left and right, respectively. In contrast to the Quick Start, the tar.bulk indicates target tissues to show.

# Store data objects in an SPHM container. 
dat.ann.tocell <- SPHM(svg=svg.mus.brain, bulk=blk.mus.aggr, cell=cell.dim, match=lis.match.blk)
covis(data=dat.ann.tocell, ID=c('Cacnb4'), dimred='UMAP', cell.group='label', tar.bulk=names(lis.match.blk), bar.width=0.09, dim.lgd.nrow=2, dim.lgd.text.size=12, h=0.6, legend.r=1.5, legend.key.size=0.02, legend.text.size=10, legend.nrow=3)

Co-visualization plot with ‘feature-by-group’ coloring. This plot is created with gene ‘Cacnb4’. Tissues in SHM are colored according to respective expression values of ‘Cacnb4’, and cells of each group in the embedding plot are assigned the same colors as the matching tissues in SHM.

In scenarios where expression values are similar across tissues, the mapping between cells and tissues can be indicated by constant colors by setting profile=FALSE.

covis(data=dat.ann.tocell, ID=c('Cacnb4'), profile=FALSE, dimred='UMAP', cell.group='label', tar.bulk=names(lis.match.blk), bar.width=0.09, dim.lgd.nrow=2, dim.lgd.text.size=12, h=0.8, legend.r=1.5, legend.key.size=0.02, legend.text.size=10, legend.nrow=3)

Co-visualization plot of constant colors. In this plot, mapping beween cell groups and tissues are indicated by fixed colors instead of expression values.

In the above examples, cells of the same group are assigned the same color in the embedding plots. It is useful to reveal matching between cell groups and tissues, but the cellular herterogeniety within groups is missing. The ‘cell-by-value’ coloring scheme is developed to overcome this limitation. In the following, this option is activated by col.idp=TRUE.

covis(data=dat.ann.tocell, ID=c('Cacnb4'), col.idp=TRUE, dimred='UMAP', cell.group='label', tar.bulk=names(lis.match.blk), bar.width=0.08, dim.lgd.nrow=2, dim.lgd.text.size=10, h=0.6, legend.r=0.1, legend.key.size=0.01, legend.text.size=10, legend.nrow=2)

Co-visualization plot with ‘cell-by-value’ coloring. This plot is created with gene ‘Cacnb4’. Tissues in SHM and cells in embedding plot are colored independently according to respective expression values of ‘Cacnb4’.

Co-clustering Labels

If both single cell and bulk gene expression data are available for the same or overlapping tissues then co-clustering can be used to assign cells to tissues automatically (Figure @ref(fig:coclusOver)). Subsequently, the predicted tissue-cell assignments can be used for creating co-visualization plots. This approach is useful for predicting the source tissues of unlabeled cells without prior knowledge as is required for the annotation approach. While attractive there are various challenges to overcome to reliably co-cluster single cell data with the corresponding tissue-level bulk data. This is due to the different properties of single cell and bulk gene expression data, such as lower sensitivity and higher sparsity in single cell compared to bulk data. This section introduces a co-clustering method that is largely based on parameter optimization including three major steps. First, both data are preprocessed to retain the most reliable expression values (Figure @ref(fig:coclusOver)A1-2). Second, the genes in the bulk data are reduced to those robustly expressed in the single cell data (Figure @ref(fig:coclusOver)A3). Third, bulk and cell data are co-clustered (Figure @ref(fig:coclusOver)C) by using optimal default settings (Table @ref(tab:optPar)) that are obtained through optimization on real data with known tissue-cell assignments. The following introduces the three steps of this method in more detail using the example of RNA-Seq data.

1. The raw count matrices of bulk and single cells are column-wise combined for joint normalization (Figure @ref(fig:coclusOver)A1). After separated from bulk data, the single-cell data are reduced to genes with robust expression across at least a proportion of cells and to cells with robust expression across at least a proportion of genes (Figure @ref(fig:coclusOver)A2). In the bulk data, genes are filtered according to expression values exceeding a cutoff over a proportion of bulk samples and a coefficient of variance (CV) between CV1 and CV2 (Figure @ref(fig:coclusOver)A2).

2. The bulk data are subsetted to the same genes as the single cell data (Figure @ref(fig:coclusOver)A3). This and the previous filtering steps reduce the sparsity in the single-cell data and the bulk data are made more compareable to the single cell data by subsetting it to the same genes.

3. Bulk and single-cell data are column-wise combined for joint embedding using PCA or UMAP (Figure @ref(fig:coclusOver)B). Co-clustering is then performed. Specifically, a graph is built on the the embedding data with methods (Table @ref(tab:optPar)) from scran (Lun, McCarthy, and Marioni 2016), where nodes are cells (or tissues) and edges are connections between nearest neighbors, and subsequently this graph is partitioned with methods (Table @ref(tab:optPar)) from igraph to obtain clusters (Csardi and Nepusz 2006). Three types of clusters are produced. First, a single tissue is co-clustered with multiple cells (Figure @ref(fig:coclusOver)C1), and this tissue is assigned to all these cells. Second, multiple tissues are co-clustered with multiple cells (Figure @ref(fig:coclusOver)C2). The nearest-neighbor tissue is assigned to each cell based on the similarity measure Spearman’s correlation coefficient. Third, no tissue is co-clustered with cells (Figure @ref(fig:coclusOver)C3). All these cells are treated as unlabeled and represent candidates for discovering novel cell types. After co-clustering, cells are labeled by tissues or remain unlabeled (Figure @ref(fig:coclusOver)D) and these labels are used for associating cells and tissues in embedding plots and SHMs, respectively (Figure @ref(fig:coclusOver)E).

Co-clustering illustration. (A) The single-cell and bulk tissue data are jointly pre-processed. (B) Single-cell and bulk data are embedded with dimension reduction methods. (C) The embedding results are used for co-clustering single-cells and bulk tissue data. Cells are assigned to tissues based on the clustering results as follows: (1) If a cluster contains a single tissue, then the cells of this cluster are assigned to the corresponding tissue. (2) If a cluster contains multiple tissues and cells, a nearest-neighbor approach resolves this ambiguous situation by assigning cells to the closest tissue sample. (3) Cells in clusters without tissue samples remain unassigned. (D) The cell-tissue assignments and the similarity scores of the predictions are stored in a table. (E) The predictions are used to color the cells by predicted source tissues in co-visualization plots.

To achieve reasonably robust default settings, the co-clustering optimization focuses on the two most important steps: joint dimension reduction and co-clustering (Figure @ref(fig:coclusOver)B-C). The relevant parameters associated with these steps are presented in Table @ref(tab:optPar), with the optimal settings highlighted in bold. These optimal settings are adopted as the default settings. The details of this optimization are given here. The following example applies the default settings (bold in Table @ref(tab:optPar)) using single cell and bulk data from mouse brain (Vacher et al. 2021; Ortiz et al. 2020). Both data sets have been simplified for demonstraton purposes.

set.seed(10)

sc.mus.pa <- system.file("extdata/shinyApp/data", "cell_mouse_cocluster.rds", package="spatialHeatmap") 
sc.mus <- readRDS(sc.mus.pa)
colData(sc.mus)[1:3, , drop=FALSE]

## DataFrame with 3 rows and 1 column
##                cell
##         <character>
## isocort     isocort
## isocort     isocort
## isocort     isocort

#mus.lis.nor <- read_cache(cache.pa, 'mus.lis.nor') 
#if (is.null(mus.lis.nor)) {
  mus.lis.nor <- norm_cell(sce=sc.mus, bulk=blk.mus, com=FALSE)
  save_cache(dir=cache.pa, overwrite=TRUE, mus.lis.nor)
#}

# Aggregate bulk replicates
blk.mus.aggr <- aggr_rep(data=mus.lis.nor$bulk, assay.na='logcounts', sam.factor='sample', aggr='mean')
# Filter bulk
blk.mus.fil <- filter_data(data=blk.mus.aggr, pOA=c(0.1, 1), CV=c(0.1, 50), verbose=FALSE) 
# Filter cell and subset bulk to genes in cell
blk.sc.mus.fil <- filter_cell(sce=mus.lis.nor$cell, bulk=blk.mus.fil, cutoff=1, p.in.cell=0.1, p.in.gen=0.01, verbose=FALSE) 

tail(attribute(svg.mus.brain)[[1]])[1:3, 1:4] # Partial features are shown.

## # A tibble: 3 × 4
##   feature                      id             fill  stroke
##   <chr>                        <chr>          <chr>  <dbl>
## 1 brainstem                    UBERON_0002298 none    0.05
## 2 midbrain                     UBERON_0001891 none    0.05
## 3 dorsal.plus.ventral.thalamus UBERON_0001897 none    0.05

Co-clustering

The co-clustering process is implemented in the function cocluster. In the following, default settings obtained from the optimization are used, where min.dim, dimred, graph.meth, and cluster refers to topDimensions, dimensionReduction, graphBuilding, and clusterDetection in Table @ref(tab:optPar) respectively. The results are saved in coclus.mus.

coclus.mus <- read_cache(cache.pa, 'coclus.mus')
if (is.null(coclus.mus)) {
  coclus.mus <- cocluster(bulk=blk.sc.mus.fil$bulk, cell=blk.sc.mus.fil$cell, min.dim=14, dimred='PCA', graph.meth='knn', cluster='fg')
  save_cache(dir=cache.pa, overwrite=TRUE, coclus.mus)
}

The tissue-cell assignments from the co-clustering process are stored in the colData slot of the coclus.mus object. The ‘cluster’ column represents cluster labels, ‘bulkCell’ indicates whether each entry represents bulk tissues or single cells, ‘sample’ represents the original labels of the bulk and cells, ‘assignedBulk’ refers to the bulk tissues assigned to cells with ‘none’ indicating unassigned cells, and ‘similarity’ represents Spearman’s correlation coefficients used for the tissue-cell assignments, serving as a measure of assignment stringency.

colData(coclus.mus)

## DataFrame with 4458 rows and 7 columns
##                     cluster    bulkCell          sample    assignedBulk
##                 <character> <character>     <character>     <character>
## cerebral.cortex       clus2        bulk cerebral.cortex            none
## hippocampus           clus6        bulk     hippocampus            none
## hypothalamus          clus6        bulk    hypothalamus            none
## cerebellum            clus6        bulk      cerebellum            none
## isocort               clus1        cell         isocort            none
## ...                     ...         ...             ...             ...
## retrohipp             clus2        cell       retrohipp cerebral.cortex
## retrohipp             clus6        cell       retrohipp      cerebellum
## retrohipp             clus6        cell       retrohipp      cerebellum
## retrohipp             clus6        cell       retrohipp      cerebellum
## retrohipp             clus6        cell       retrohipp      cerebellum
##                  similarity     index sizeFactor
##                 <character> <integer>  <numeric>
## cerebral.cortex        none         1  45.811788
## hippocampus            none         2 100.736625
## hypothalamus           none         3  28.249392
## cerebellum             none         4  44.415396
## isocort                none         5   0.711862
## ...                     ...       ...        ...
## retrohipp             0.591      4454   1.006589
## retrohipp             0.257      4455   0.674636
## retrohipp             0.429      4456   0.646310
## retrohipp             0.398      4457   0.564467
## retrohipp             0.538      4458   0.636357

The tissue-cell assignments can be controled by filtering the values in the similarity column. This utility is impletmented in function filter_asg, where only assignments with similarities above the cutoff min.sim will be retained. Utilities are also developed to tailor the assignments, such as assigning specific tissues to cells without assignments. Details of the tailoring are explained in the Supplementary Section.

coclus.mus <- filter_asg(coclus.mus, min.sim=0.1)

The co-clusters that consist of tissues and cells can be visualized in an embeding plot with the function plot_dim. The dim argument specifies an embedding method. To see all co-clusters, assign TRUE to cocluster.only, in this case, other clusters containing only cells will be in grey. To only show a specific cluster, assign the cluster label to group.sel, for example, group.sel='clus3'. In the embedding plot, tissues and cells are indicated by large and small circles respectively.

plot_dim(coclus.mus, dim='PCA', color.by='cluster', cocluster.only=TRUE, group.sel=NULL)

Embedding plot of co-clusters. Large and small circles refer to tissues and single cells respectively.

# Separate bulk data.
coclus.blk <- subset(coclus.mus, , bulkCell=='bulk')
# Separate single cell data.
coclus.sc <- subset(coclus.mus, , bulkCell=='cell')

# Store data objects in an SPHM container. 
dat.auto.idp <- SPHM(svg=svg.mus.brain, bulk=coclus.blk, cell=coclus.sc)
covis(data=dat.auto.idp, ID=c('Atp2b1'), dimred='TSNE', tar.cell=c('hippocampus', 'hypothalamus', 'cerebellum', 'cerebral.cortex'), col.idp=TRUE, dim.lgd.text.size=10, dim.lgd.nrow=2, bar.width=0.08, legend.nrow=3, h=0.6, legend.key.size=0.01, legend.text.size=10, legend.r=0.27)

Spatial Single-Cell Data

Except for conventional single-cell data, the co-visualization module is able to co-visualize spatially resolved single-cell (SRSC) and bulk data as well. In the following example, the bulk data are the same as the Annotation Labels section, while the SRSC data are from the anterior region of sagittal mouse brain (10X Genomics Visium). For simplicity, the pre-processing steps of bulk and SRSC data are not described here and the pre-processed data are imported directly. These steps include (1) jointly normalizing bulk and SRSC data and subsequently separating them, which is performed with the the function norm_srsc in spatialHeatmap, (2) reducing dimensions (PCA, UMAP, TSNE) of the separated SRSC data, and (3) clustering the SRSC data. More details are described in the Seurat vignette Hao et al. (2021).

The pre-processed bulk and SRSC data are imported and partially shown.

# Importing bulk data.
blk.sp <- readRDS(system.file("extdata/shinyApp/data", "bulk_sp.rds", package="spatialHeatmap"))
# Bulk assay data are partially shown.
assay(blk.sp)[1:3, ]
## 3 x 4 sparse Matrix of class "dgCMatrix"
##        cerebral.cortex hippocampus hypothalamus cerebellum
## Resp18               .           .            7          .
## Epha4                5           9            2          .
## Scg2                 4           6           52          4
# Importing SRSC data.
srt.sc <- read_cache(cache.pa, 'srt.sc') 
## No valid record is detected for srt.sc !
if (is.null(srt.sc)) {
  srt.sc <- readRDS(gzcon(url("https://zenodo.org/record/8240964/files/srt_sc.rds?download=1")))
  save_cache(dir=cache.pa, overwrite=TRUE, srt.sc)
}
## Cache directory: ~/.cache/shm
## [1] "~/.cache/shm"
# SRSC assay data are partially shown.
srt.sc@assays$SCT@data[1:3, 1:2]
## 3 x 2 sparse Matrix of class "dgCMatrix"
##        AAACAAGTATCTCCCA.1 AAACACCAATAACTGC.1
## Resp18          1.7917595           1.386294
## Epha4           0.6931472           .       
## Scg2            2.5649494           3.091042

The SRSC data are stored in a Seurat object. The cluster labels of cells are stored in the seurat_clusters column of the meta.data slot and partially shown.

# SRSC metadata of cells are partially shown.
srt.sc@meta.data[1:2, c('seurat_clusters', 'nFeature_SCT')]
##                    seurat_clusters nFeature_SCT
## AAACAAGTATCTCCCA.1          clus11          258
## AAACACCAATAACTGC.1           clus9          237

The coordinates of spatial spots are stored in the image slot in the Seurat object and partially shown.

# Coordinates of spatial spots are partially shown.
srt.sc@images$anterior1@coordinates[1:2, c('imagerow', 'imagecol')]
##                    imagerow imagecol
## AAACAAGTATCTCCCA.1     7475     8501
## AAACACCAATAACTGC.1     8553     2788

The aSVG of mouse brain is included in spatialHeatmap and imported into an SVG object.

svg.mus.sp <- read_svg(system.file("extdata/shinyApp/data", "mus_musculus.brain_sp.svg", package="spatialHeatmap"), srsc=TRUE)

In order to position spatial spots in the SRSC data correctly in the aSVG, a shape named overlay that defines the region of the spatial spots is required in the aSVG. By using this shape as a reference, the coordinates of spatial spots in the SRSC data are transformed so that all these spots are positioned within this shape. The overlay shape can be created in an SVG editor such as Inkscape. The process involves using the spatial plot generated by the SpatialFeaturePlot function in Seurat as a template.

attribute(svg.mus.sp)[[1]][7:8, c('feature', 'id', 'fill', 'stroke')]

## # A tibble: 2 × 4
##   feature           id             fill  stroke
##   <chr>             <chr>          <chr>  <dbl>
## 1 overlay           overlay        none   0.258
## 2 medulla.oblongata UBERON_0001896 none   0.1

In the SVG object, the angle slot is designed for optionally rotating the spatial spots. In the SRSC data generated by the Visium technology, a 90 degree rotation is required for correctly positioning the spatial spots, which is shown below.

angle(svg.mus.sp)[[1]] <- angle(svg.mus.sp)[[1]] + 90 

The co-visualization plot is created with the gene ‘Epha4’ using ‘cell-by-value’ coloring. Assigning FALSE to profile will turn on the ‘fixed-group’ coloring. The cluster labels are treated as the cell group labels (cell.group='seurat_clusters'). The ‘cerebral.cortex’ tissue anatomically correspond to cell clusters of ‘clus1’, ‘clus2’, ‘clus3’, and ‘clus5’, and this association is defined by a list called lis.match. The co-visualization plot consists of an embedding plot on the left, a single-cell SHM (scSHM) in the middle, and a SHM on the right. In the scSHM, spatial spots are positioned in the overlay region and superimposed the anatomical structures in the aSVG.

# Association between "cerebral.cortex" and clusters.
lis.match <- list(cerebral.cortex=c('clus1', 'clus2', 'clus3', 'clus5'))   
dat.srsc <- SPHM(svg=svg.mus.sp, bulk=blk.sp, cell=srt.sc, match=lis.match)
covis(data=dat.srsc, ID='Epha4', assay.na='logcounts', dimred='TSNE', cell.group='seurat_clusters', tar.bulk=c('cerebral.cortex'), col.idp=TRUE, bar.width=0.07, dim.lgd.nrow=2, dim.lgd.text.size=8, legend.r=0.1, legend.key.size=0.013, legend.text.size=10, legend.nrow=3, h=0.6, profile=TRUE, ncol=3, vjust=5, dim.lgd.key.size=3, size.r=0.97, dim.axis.font.size=8, size.pt=1.5, lgd.plots.size=c(0.35, 0.25, 0.35), verbose=FALSE)

Single-cell Clustering Labels

To provide additional flexibility for defining cell groupings, several other options are provided. Here users can assign cell groups manually or by using clustering methods that are often used in the analysis of single-cell data. The resulting cell grouping or cluster information needs to be stored in a tabular file, that will be imported into an SCE object (here cell_group function). The following demonstration uses the same single cell and aSVG instance as the example of annotation labels above. The only difference is an additional clustering step. For demonstration purposes a small example of a cluster file is included in the spatialHeatmap package. In this case the group labels were created by the cluster_cell function. The details of this function are available in its help file. The cluster file contains at least two columns: a column (here cell) with single cell identifiers used under colData and a column (here cluster) with the cell group labels. For practical reasons of building this vignette a pure manual example could not be used here. However, the chosen clustering example can be easily adapted to manual or hybrid grouping approaches since the underlying tabular data structure is the same for both that can be generated in most text or spreadsheet programs.

manual.clus.mus.sc.pa <- system.file("extdata/shinyApp/data", "manual_cluster_mouse_brain.txt", package="spatialHeatmap")
manual.clus.mus.sc <- read.table(manual.clus.mus.sc.pa, header=TRUE, sep='\t')
manual.clus.mus.sc[1:3, ]

##                 cell cluster
## 1 C1.1772078.029.F11   clus7
## 2 C1.1772089.202.E04   clus7
## 3 C1.1772099.091.D10   clus1

The cell_group function can be used to append the imported group labels to the colData slot of an SCE object.

sce.clus <- cell_group(sce=sce.dimred.quick, df.group=manual.clus.mus.sc, cell='cell', cell.group='cluster')
colData(sce.clus)[1:3, c('cluster', 'label', 'variable')]

## DataFrame with 3 rows and 3 columns
##                        cluster        label    variable
##                    <character>  <character> <character>
## C1.1772078.029.F11       clus7 hypothalamus     control
## C1.1772089.202.E04       clus7       SN.VTA     control
## C1.1772099.091.D10       clus1  dorsal.horn     control

An embedding plot of single cell data is created. The cells represented as dots are colored by the grouping information stored in the cluster column of the colData slot of SCE.

plot_dim(sce.clus, color.by="cluster", dim='TSNE')

Embedding plot of single cells. The cells (dots) are colored by the grouping information stored in the colData slot of the corresponding SCE object .

The same mouse brain aSVG as above is used here.

tail(attribute(svg.mus.brain)[[1]])[1:3, 1:4]

## # A tibble: 3 × 4
##   feature                      id             fill  stroke
##   <chr>                        <chr>          <chr>  <dbl>
## 1 brainstem                    UBERON_0002298 none    0.05
## 2 midbrain                     UBERON_0001891 none    0.05
## 3 dorsal.plus.ventral.thalamus UBERON_0001897 none    0.05

Similarly as above, a mapping list is used to match the cell clusters with aSVG features.

lis.match.clus <- list(clus1=c('cerebral.cortex'), clus3=c('brainstem', 'medulla.oblongata'))

This example is demonstrated with ‘cell-by-group’ coloring, so gene expression values need to be summarized for the cells within each group label. Any grouping column in colData can be used as labels for summarizing. In this example, the cluster labels are used.

If additional experimental variables (e.g. treatments) are provided, the summarizing will consider them as well (here variable). The following example uses the cluster and variable columns as group labels and experimental variables, respectively.

sce.clus.aggr <- aggr_rep(sce.clus, assay.na='logcounts', sam.factor='cluster', con.factor='variable', aggr='mean')
colData(sce.clus.aggr)[1:3, c('cluster', 'label', 'variable')]

## DataFrame with 3 rows and 3 columns
##                    cluster           label    variable
##                <character>     <character> <character>
## clus7__control       clus7    hypothalamus     control
## clus1__control       clus1     dorsal.horn     control
## clus5__control       clus5 corpus.callosum     control

The co-visualization plot with ‘cell-by-group’ coloring is created with gene Tcea1.

# Store data objects in an SPHM container. 
dat.man.tobulk <- SPHM(svg=svg.mus.brain, bulk=sce.clus.aggr, cell=sce.clus, match=lis.match.clus)
covis(data=dat.man.tobulk, ID=c('Tcea1'), dimred='TSNE', cell.group='cluster', assay.na='logcounts', tar.cell=names(lis.match.clus), bar.width=0.09, dim.lgd.nrow=1, h=0.6, legend.r=1.5, legend.key.size=0.02, legend.text.size=12, legend.nrow=4, verbose=FALSE)

Co-visualization plot created with cluster groupings.

Co-clustering Labels: Other Coloring

# Separate single cell data.
coclus.sc <- subset(coclus.mus, , bulkCell=='cell')
# Summarize expression values in each cell group.
sc.aggr.coclus <- aggr_rep(data=coclus.sc, assay.na='logcounts', sam.factor='assignedBulk', aggr='mean')
colData(sc.aggr.coclus)

## DataFrame with 5 rows and 8 columns
##                     cluster    bulkCell      sample    assignedBulk  similarity
##                 <character> <character> <character>     <character> <character>
## none                  clus1        cell     isocort            none        none
## cerebral.cortex       clus2        cell     isocort cerebral.cortex       0.582
## hypothalamus          clus6        cell        olfa    hypothalamus       0.222
## hippocampus           clus6        cell        olfa     hippocampus       0.363
## cerebellum            clus6        cell    pallidum      cerebellum       0.486
##                     index sizeFactor       spFeature
##                 <integer>  <numeric>     <character>
## none                    5   0.711862            none
## cerebral.cortex        30   0.685422 cerebral.cortex
## hypothalamus          353   1.136880    hypothalamus
## hippocampus           500   1.055465     hippocampus
## cerebellum            897   0.867205      cerebellum

# Store data objects in an SPHM container. 
dat.auto.tobulk <- SPHM(svg=svg.mus.brain, bulk=sc.aggr.coclus, cell=coclus.sc)
covis(data=dat.auto.tobulk, ID=c('Atp2b1'), dimred='TSNE', tar.cell=c('hippocampus', 'hypothalamus', 'cerebellum', 'cerebral.cortex'), dim.lgd.text.size=10, dim.lgd.nrow=2, bar.width=0.09, legend.nrow=5, h=0.6, legend.key.size=0.02, legend.text.size=12, legend.r=1.5)

coclus.blk <- subset(coclus.mus, , bulkCell=='bulk')

colnames(coclus.blk) %in% attribute(svg.mus.brain)[[1]]$feature

## [1] TRUE TRUE TRUE TRUE

# Store data objects in an SPHM container. 
dat.auto.tocell <- SPHM(svg=svg.mus.brain, bulk=coclus.blk, cell=coclus.sc)
covis(data=dat.auto.tocell, ID=c('Atp2b1'), dimred='TSNE', tar.bulk=colnames(coclus.blk), assay.na='logcounts', legend.nrow=5, dim.lgd.text.size=10, dim.lgd.nrow=2, bar.width=0.08, h=0.6, legend.key.size=0.02, legend.text.size=12, legend.r=1.5)

covis(data=dat.auto.tocell, ID=c('Atp2b1'), dimred='TSNE', profile=FALSE, assay.na='logcounts', legend.nrow=4, dim.lgd.text.size=10, dim.lgd.nrow=2, bar.width=0.09)

Tailoring Co-clustering Results

Command-line Method

The tissue-cell assignments in the automated co-clustering can be optionally tailored. Both command-line and graphical methods are supported for this purpose. In the command-line, the first step is to visualize single cells in an embedding plot as shown below.

plot_dim(coclus.mus, dim='PCA', color.by='sample', x.break=seq(-10, 10, 1), y.break=seq(-10, 10, 1), panel.grid=TRUE, lgd.ncol=2)

Embedding plot of tissues and single cells of mouse brain. Tissues and single cells are indicated by large and small circles respectively.

Second, select cells with x-y coordinate ranges (x.min, x.max, y.min, y.max) in the embedding plot and define corresponding desired tissues (desiredBulk) in form of a data.frame (df.desired.bulk). In order to define more accurate coordinates, tune the x-y axis breaks (x.break, y.break) and set panel.grid=TRUE in the first step. In the data.frame, the dimred represents embedding plots where the coordinates come from. For demonstration, some cells near the tissue hippocampus (the large green dot) are selected and hippocampus is chosen as the desired tissue.

df.desired.bulk <- data.frame(x.min=c(-8), x.max=c(5), y.min=c(1), y.max=c(5), desiredBulk=c('hippocampus'), dimred='PCA') 
df.desired.bulk

Next, the tissue-cell assignments from co-clustering are updated with the function refine_asg by incorporating the desired tissues. The similarities corresponding to desired tissues are internally set at the maximum of 1. After that, single-cell data are separated from bulk data for creating co-visualization plots.

# Incorporate desired bulk
coclus.mus.tailor <- refine_asg(sce.all=coclus.mus, df.desired.bulk=df.desired.bulk)
# Separate cells from bulk
coclus.sc.tailor <- subset(coclus.mus.tailor, , bulkCell=='cell')

After the above tailoring steps, the co-visualization plot with ‘feature-by-group’ coloring is created on gene ‘Atp2b1’ (Figure @ref(fig:aftertailor)). To reveal the tailoring, only the tissue hippocampus is selected to show (tar.bulk=c('hippocampus')). Cells of hippocampus in the embedding plot include tailored cells in df.desired.bulk and those labeled hippocampus in co-clustering. All these cells have the same color as the tissue hippocampus in SHM. As a comparison, the hippocampus cells before tailoring is shown in Figure @ref(fig:beforetailor).

# Store data objects in an SPHM container. 
dat.auto.tocell.tailor <- SPHM(svg=svg.mus.brain, bulk=coclus.blk, cell=coclus.sc.tailor)
covis(data=dat.auto.tocell.tailor, ID=c('Atp2b1'), dimred='PCA', tar.bulk=c('hippocampus'), assay.na='logcounts', legend.nrow=4, dim.lgd.text.size=10, dim.lgd.nrow=2, bar.width=0.08, legend.r=1.5)

<img src=“/tmp/RtmpqXOjVu/Rbuild310b753a6a12/spatialHeatmap/vignettes/covisualize_files/figure-html/aftertailor-1.png” alt=“Co-visualization plot with”feature-by-group” coloring after tailoring. This plot is created on gene “Atp2b1”. Only the tissue and cells of hippocampus are shown to indicate the tailoring.” width=“100%” />

Co-visualization plot with “feature-by-group” coloring after tailoring. This plot is created on gene “Atp2b1”. Only the tissue and cells of hippocampus are shown to indicate the tailoring.

covis(data=dat.auto.tocell, ID=c('Atp2b1'), dimred='PCA', tar.bulk=c('hippocampus'), assay.na='logcounts', legend.nrow=4, dim.lgd.text.size=10, dim.lgd.nrow=2, bar.width=0.08, legend.r=1.5)

<img src=“/tmp/RtmpqXOjVu/Rbuild310b753a6a12/spatialHeatmap/vignettes/covisualize_files/figure-html/beforetailor-1.png” alt=“Co-visualization plot with”feature-by-group” coloring before tailoring. This plot is created on gene “Atp2b1”. Only the tissue and cells of hippocampus are shown.” width=“100%” />

Co-visualization plot with “feature-by-group” coloring before tailoring. This plot is created on gene “Atp2b1”. Only the tissue and cells of hippocampus are shown.

desired.blk.pa <- system.file("extdata/shinyApp/data", "selected_cells_with_desired_bulk.txt", package="spatialHeatmap")
df.desired.blk <- read.table(desired.blk.pa, header=TRUE, row.names=1, sep='\t')
df.desired.blk[1:3, ]