1 Welcome

Welcome to the spatialLIBD project! It is composed of:

a shiny web application that we are hosting at spatial.libd.org/spatialLIBD/ that can handle a limited set of concurrent users,
a Bioconductor package at bioconductor.org/packages/spatialLIBD (or from here) that lets you analyze the data and run a local version of our web application (with our data or yours),
and a research article with the scientific knowledge we drew from this dataset. The analysis code for our project is available here and the high quality figures for the manuscript are available through Figshare.

The web application allows you to browse the LIBD human dorsolateral pre-frontal cortex (DLPFC) spatial transcriptomics data generated with the 10x Genomics Visium platform. Through the R/Bioconductor package you can also download the data as well as visualize your own datasets using this web application. Please check the manuscript or bioRxiv pre-print for more details about this project.

If you tweet about this website, the data or the R package please use the #spatialLIBD hashtag. You can find previous tweets that way as shown here. Thank you! Tweet #spatialLIBD

1.1 Study design

As a quick overview, the data presented here is from portion of the DLPFC that spans six neuronal layers plus white matter (A) for a total of three subjects with two pairs of spatially adjacent replicates (B). Each dissection of DLPFC was designed to span all six layers plus white matter (C). Using this web application you can explore the expression of known genes such as SNAP25 (D, a neuronal gene), MOBP (E, an oligodendrocyte gene), and known layer markers from mouse studies such as PCP4 (F, a known layer 5 marker gene).

1.2 Shiny website mirrors

2 Basics

2.1 Install `spatialLIBD`

R is an open-source statistical environment which can be easily modified to enhance its functionality via packages. spatialLIBD is a R package available via Bioconductor. R can be installed on any operating system from CRAN after which you can install spatialLIBD by using the following commands in your R session:

if (!requireNamespace("BiocManager", quietly = TRUE)) {
    install.packages("BiocManager")
}

BiocManager::install("spatialLIBD")

## Check that you have a valid Bioconductor installation
BiocManager::valid()

2.2 Required knowledge

spatialLIBD (Pardo, Spangler, Weber, et al., 2021) is based on many other packages and in particular in those that have implemented the infrastructure needed for dealing with single cell RNA sequencing data, visualization functions, and interactive data exploration. That is, packages like SingleCellExperiment that allow you to store the data, ggplot2 and plotly for visualizing the data, and shiny for building an interactive interface. A spatialLIBD user who only accesses the web application is not expected to deal with those packages directly. A spatialLIBD user will need to be familiar with SingleCellExperiment and ggplot2 to understand the data provided by spatialLIBD or the graphical results spatialLIBD provides. Furthermore, it’ll be useful for the user to know about shiny and plotly if you wish to adapt the web application provided by spatialLIBD.

If you are asking yourself the question “Where do I start using Bioconductor?” you might be interested in this blog post.

2.3 Asking for help

As package developers, we try to explain clearly how to use our packages and in which order to use the functions. But R and Bioconductor have a steep learning curve so it is critical to learn where to ask for help. The blog post quoted above mentions some but we would like to highlight the Bioconductor support site as the main resource for getting help regarding Bioconductor. Other alternatives are available such as creating GitHub issues and tweeting. However, please note that if you want to receive help you should adhere to the posting guidelines. It is particularly critical that you provide a small reproducible example and your session information so package developers can track down the source of the error.

2.4 Citing `spatialLIBD`

We hope that spatialLIBD will be useful for your research. Please use the following information to cite the package and the research article describing the data provided by spatialLIBD. Thank you!

## Citation info
citation("spatialLIBD")
#> 
#> Pardo B, Spangler A, Weber LM, Hicks SC, Jaffe AE, Martinowich K, Maynard KR, Collado-Torres L (2021).
#> "spatialLIBD: an R/Bioconductor package to visualize spatially-resolved transcriptomics data." _bioRxiv_.
#> doi: 10.1101/2021.04.29.440149 (URL: https://doi.org/10.1101/2021.04.29.440149), <URL:
#> https://www.biorxiv.org/content/10.1101/2021.04.29.440149v1>.
#> 
#> Maynard KR, Collado-Torres L, Weber LM, Uytingco C, Barry BK, Williams SR, II JLC, Tran MN, Besich Z,
#> Tippani M, Chew J, Yin Y, Kleinman JE, Hyde TM, Rao N, Hicks SC, Martinowich K, Jaffe AE (2021).
#> "Transcriptome-scale spatial gene expression in the human dorsolateral prefrontal cortex." _Nature
#> Neuroscience_. doi: 10.1038/s41593-020-00787-0 (URL: https://doi.org/10.1038/s41593-020-00787-0), <URL:
#> https://www.nature.com/articles/s41593-020-00787-0>.
#> 
#> To see these entries in BibTeX format, use 'print(<citation>, bibtex=TRUE)', 'toBibtex(.)', or set
#> 'options(citation.bibtex.max=999)'.

3 Overview

The spatialLIBD (Pardo, Spangler, Weber, et al., 2021) package was developed for analyzing the human dorsolateral prefrontal cortex (DLPFC) spatial transcriptomics data generated with the 10x Genomics Visium technology by researchers at the Lieber Institute for Brain Development (LIBD) (Maynard, Collado-Torres, Weber, et al., 2021). An initial shiny application was developed for interactively exploring this data and for assigning human brain layer labels to the each spot for each sample generated. While this was useful enough for our project, we made this Bioconductor package in case you want to:

access our Visium data to get some data from this new technology and develop methods or infrastructure for other Visium datasets.
re-shape your data into what ours is structured as, then re-use the visualization functions and/or the shiny app itself.
want to explore our data in more detail. This can range from launching the shiny application locally to diving into the specifics of the data from our project (Maynard, Collado-Torres, Weber, et al., 2021).

In this vignette we’ll showcase how you can access the Human DLPFC LIBD Visium dataset (Maynard, Collado-Torres, Weber, et al., 2021), the R functions provided by spatialLIBD (Pardo, Spangler, Weber, et al., 2021), and an overview of how you can re-shape your own Visium dataset to match the structure we used.

To get started, please load the spatialLIBD package.

library("spatialLIBD")

4 Human DLPFC Visium dataset

The human DLPFC 10x Genomics Visium dataset analyzed by LIBD researchers and colleagues is described in detail by Maynard, Collado-Torres et al (Maynard, Collado-Torres, Weber, et al., 2021). However, briefly, this dataset is composed of:

Three brain subjects (all controls; two males, one female; ages 30-46; details).
Four images per subject: two spatially adjacent replicates at position 0, then two more spatially adjacent replicates 300 micrometers away.
Slices designed to cover layers 1 through 6 and the white matter (WM) of the dorsolateral prefrontal cortex (DLPFC).

4.1 Data specifics

We combined all the Visium data into a single SpatialExperiment (Righelli, Risso, Crowell, et al., 2021) object that we typically refer to as spe 111 Check this code for details on how we built the spe object. In particular check convert_sce.R and sce_scran.R.. It has 33,538 genes (rows) and 47,681 spots (columns). This is the initial point for most of our analyses (code available on GitHub). Using spatialLIBD (Pardo, Spangler, Weber, et al., 2021) we manually assigned each spot across all 12 images to a layer (L1 through L6 or WM). We then compressed the spot-level data at the layer-level using a pseudo-bulking approach resulting in the SingleCellExperiment object we typically refer to as sce_layer 222 Check this code for details on how we built the sce_layer object. In particular check spots_per_layer.R and layer_enrichment.R.. We then computed for each gene t or F statistics assessing whether the gene had higher expression in a given layer compared to the rest (enrichment; t-stat), between one layer and another layer (pairwise; t-stat), or had any expression variability across all layers (anova; F-stat). The results from the models are stored in what we refer to as modeling_results 333 Check this code for details on how we built the modeling_results object. In particular check layer_specificity_fstats.R, layer_specificity.R, and misc_numbers.R..

In summary,

spe is the SpatialExperiment object with all the spot-level data and the histology information for visualization of the data.
sce_layer is the SingleCellExperiment object with the layer-level data.
modeling_results contains the layer-level enrichment, pairwise and anova statistics.

4.2 Downloading the data with `spatialLIBD`

Using spatialLIBD (Pardo, Spangler, Weber, et al., 2021) you can download all of these R objects. They are hosted by Bioconductor’s ExperimentHub (Morgan and Shepherd, 2021) resource and you can download them using spatialLIBD::fetch_data(). fetch_data() will query ExperimentHub which in turn will download the data and cache it so you don’t have to download it again. If ExperimentHub is unavailable, then fetch_data() has a backup option that does not cache the files 444 You can change the destdir argument and specific a specific location that you will use and re-use. However the default value of destdir is a temporary directory that will be wiped out once you close your R session. Below we obtain all of these objects.

## Connect to ExperimentHub
ehub <- ExperimentHub::ExperimentHub()
#> snapshotDate(): 2021-05-05

## Download the small example sce data
sce <- fetch_data(type = "sce_example", eh = ehub)
#> Warning: DEPRECATION: As of BiocFileCache (>1.15.1), default caching location has changed.
#>   Problematic cache: /home/biocbuild/.cache/BiocFileCache
#>   See https://www.bioconductor.org/packages/devel/bioc/vignettes/BiocFileCache/inst/doc/BiocFileCache.html#default-caching-location-update
#> 2021-05-20 14:49:25 loading file ~/.cache/BiocFileCache/224e9c232ebe66_sce_sub_for_vignette.Rdata%3Fdl%3D1

## Convert to a SpatialExperiment object
spe <- sce_to_spe(sce)

## If you want to download the full real data (about 2.1 GB in RAM) use:
if (FALSE) {
    if (!exists("spe")) spe <- fetch_data(type = "spe", eh = ehub)
}

## Query ExperimentHub and download the data
if (!exists("sce_layer")) sce_layer <- fetch_data(type = "sce_layer", eh = ehub)
#> Warning: DEPRECATION: As of BiocFileCache (>1.15.1), default caching location has changed.
#>   Problematic cache: /home/biocbuild/.cache/BiocFileCache
#>   See https://www.bioconductor.org/packages/devel/bioc/vignettes/BiocFileCache/inst/doc/BiocFileCache.html#default-caching-location-update
#> 2021-05-20 14:49:32 loading file ~/.cache/BiocFileCache/b7e2317e61223_Human_DLPFC_Visium_processedData_sce_scran_sce_layer_spatialLIBD.Rdata%3Fdl%3D1
modeling_results <- fetch_data("modeling_results", eh = ehub)
#> Warning: DEPRECATION: As of BiocFileCache (>1.15.1), default caching location has changed.
#>   Problematic cache: /home/biocbuild/.cache/BiocFileCache
#>   See https://www.bioconductor.org/packages/devel/bioc/vignettes/BiocFileCache/inst/doc/BiocFileCache.html#default-caching-location-update
#> 2021-05-20 14:49:33 loading file ~/.cache/BiocFileCache/b7e232f3fdcb8_Human_DLPFC_Visium_modeling_results.Rdata%3Fdl%3D1

Once you have downloaded the objects, we can explore them a little bit

## spot-level data
spe
#> class: SpatialExperiment 
#> dim: 33538 47681 
#> metadata(0):
#> assays(2): counts logcounts
#> rownames(33538): ENSG00000243485 ENSG00000237613 ... ENSG00000277475 ENSG00000268674
#> rowData names(9): source type ... gene_search is_top_hvg
#> colnames(47681): AAACAACGAATAGTTC-1 AAACAAGTATCTCCCA-1 ... TTGTTTCCATACAACT-1 TTGTTTGTGTAAATTC-1
#> colData names(66): sample_id Cluster ... spatialLIBD ManualAnnotation
#> reducedDimNames(6): PCA TSNE_perplexity50 ... TSNE_perplexity80 UMAP_neighbors15
#> mainExpName: NULL
#> altExpNames(0):
#> spatialData names(3) : in_tissue array_row array_col
#> spatialCoords names(2) : pxl_col_in_fullres pxl_row_in_fullres
#> imgData names(4): sample_id image_id data scaleFactor

## layer-level data
sce_layer
#> class: SingleCellExperiment 
#> dim: 22331 76 
#> metadata(0):
#> assays(2): counts logcounts
#> rownames(22331): ENSG00000243485 ENSG00000238009 ... ENSG00000278384 ENSG00000271254
#> rowData names(10): source type ... is_top_hvg is_top_hvg_sce_layer
#> colnames(76): 151507_Layer1 151507_Layer2 ... 151676_Layer6 151676_WM
#> colData names(13): sample_name layer_guess ... layer_guess_reordered_short spatialLIBD
#> reducedDimNames(6): PCA TSNE_perplexity5 ... UMAP_neighbors15 PCAsub
#> mainExpName: NULL
#> altExpNames(0):

## list of modeling result tables
sapply(modeling_results, class)
#>        anova   enrichment     pairwise 
#> "data.frame" "data.frame" "data.frame"
sapply(modeling_results, dim)
#>      anova enrichment pairwise
#> [1,] 22331      22331    22331
#> [2,]    10         23       65
sapply(modeling_results, function(x) {
    head(colnames(x))
})
#>      anova          enrichment      pairwise          
#> [1,] "f_stat_full"  "t_stat_WM"     "t_stat_WM-Layer1"
#> [2,] "p_value_full" "t_stat_Layer1" "t_stat_WM-Layer2"
#> [3,] "fdr_full"     "t_stat_Layer2" "t_stat_WM-Layer3"
#> [4,] "full_AveExpr" "t_stat_Layer3" "t_stat_WM-Layer4"
#> [5,] "f_stat_noWM"  "t_stat_Layer4" "t_stat_WM-Layer5"
#> [6,] "p_value_noWM" "t_stat_Layer5" "t_stat_WM-Layer6"

The modeling statistics are in wide format, which can make some visualizations complicated. The function sig_genes_extract_all() provides a way to convert them into long format and add some useful information. Let’s do so below.

## Convert to a long format the modeling results
## This takes a few seconds to run
system.time(
    sig_genes <-
        sig_genes_extract_all(
            n = nrow(sce_layer),
            modeling_results = modeling_results,
            sce_layer = sce_layer
        )
)
#>    user  system elapsed 
#>   8.029   0.384   8.413

## Explore the result
class(sig_genes)
#> [1] "DFrame"
#> attr(,"package")
#> [1] "S4Vectors"
dim(sig_genes)
#> [1] 1138881      12

5 Interactively explore the `spatialLIBD` data

Now that you have downloaded the data, you can interactively explore the data using a shiny (Chang, Cheng, Allaire, Sievert, Schloerke, Xie, Allen, McPherson, Dipert, and Borges, 2021) web application contained within spatialLIBD (Pardo, Spangler, Weber, et al., 2021). To do so, use the run_app() function as shown below:

if (interactive()) {
    run_app(
        spe = spe,
        sce_layer = sce_layer,
        modeling_results = modeling_results,
        sig_genes = sig_genes
    )
}

The spatialLIBD shiny application allows you to browse the spot-level data and interactively label spots, as well as explore the layer-level results. Once you launch it, check the Documentation tab for each view for more details. In order to avoid duplicating the documentation, we provide all the details on the shiny application itself.

Though overall, this application allows you to export all static visualizations as PDF files or all interactive visualizations as PNG files, as well as all result table as CSV files. This is what produces the version you can access without any R use from your side at spatial.libd.org/spatialLIBD/.

6 `spatialLIBD` functions

We already covered fetch_data() which allows you to download the Human DLPFC Visium data from LIBD researchers and colleagues (Maynard, Collado-Torres, Weber, et al., 2021).

6.1 Spot-level clusters and discrete variables

With the spe object that contains the spot-level data, we can visualize any discrete variable such as the layers using vis_clus() and related functions. These functions know where to extract and how to visualize the histology information.

## View our LIBD layers for one sample
vis_clus(
    spe = spe,
    clustervar = "layer_guess_reordered",
    sampleid = "151673",
    colors = libd_layer_colors,
    ... = " LIBD Layers"
)
#> Warning: DEPRECATION: As of BiocFileCache (>1.15.1), default caching location has changed.
#>   Problematic cache: /home/biocbuild/.cache/BiocFileCache
#>   See https://www.bioconductor.org/packages/devel/bioc/vignettes/BiocFileCache/inst/doc/BiocFileCache.html#default-caching-location-update

Most of the variables stored in spe are discrete variables and as such, you can visualize them using vis_clus() and vis_grid_clus() for one or more than one sample respectively.

## This is not fully precise, but gives you a rough idea
## Some integer columns are actually continuous variables
table(sapply(colData(spe), class) %in% c("factor", "integer"))
#> 
#> FALSE  TRUE 
#>    12    57

## This is more precise (one cluster has 28 unique values)
table(sapply(colData(spe), function(x) length(unique(x))) < 29)
#> 
#> FALSE  TRUE 
#>     7    62

Notably, vis_clus() has a spatial logical(1) argument which is useful if you want to visualize the data without the histology information provided by geom_spatial() (a custom ggplot2::layer()). In particular, this is useful if you then want to use plotly::ggplotly() or other similar functions on the resulting ggplot2::ggplot() object.

## View our LIBD layers for one sample
## without spatial information
vis_clus(
    spe = spe,
    clustervar = "layer_guess_reordered",
    sampleid = "151673",
    colors = libd_layer_colors,
    ... = " LIBD Layers",
    spatial = FALSE
)

Some helper functions include get_colors() and sort_clusters() as well as the libd_layer_colors object included in spatialLIBD (Pardo, Spangler, Weber, et al., 2021).

## Color palette designed by Lukas M. Weber with feedback from the team.
libd_layer_colors
#>        Layer1        Layer2        Layer3        Layer4        Layer5        Layer6            WM            NA 
#>     "#F0027F"     "#377EB8"     "#4DAF4A"     "#984EA3"     "#FFD700"     "#FF7F00"     "#1A1A1A" "transparent" 
#>           WM2 
#>     "#666666"

6.2 Spot-level genes and continuous variables

Similar to vis_clus(), the vis_gene() family of functions use the spe spot-level object to visualize the gene expression or any continuous variable such as the number of cells per spots. That is, vis_gene() can visualize any of the assays(spe) or any of the continuous variables stored in colData(spe). If you want to visualize more than one sample at a time, use vis_grid_gene() instead. And just like vis_clus(), vis_gene() has a spatial logical(1) argument to turn off the custom spatial ggplot2::layer() produced by geom_spatial().

## Available gene expression assays
assayNames(spe)
#> [1] "counts"    "logcounts"

## Not all of these make sense to visualize
## In particular, the key is not useful to visualize.
colnames(colData(spe))
#>  [1] "sample_id"                   "Cluster"                     "sum_umi"                    
#>  [4] "sum_gene"                    "subject"                     "position"                   
#>  [7] "replicate"                   "subject_position"            "discard"                    
#> [10] "key"                         "cell_count"                  "SNN_k50_k4"                 
#> [13] "SNN_k50_k5"                  "SNN_k50_k6"                  "SNN_k50_k7"                 
#> [16] "SNN_k50_k8"                  "SNN_k50_k9"                  "SNN_k50_k10"                
#> [19] "SNN_k50_k11"                 "SNN_k50_k12"                 "SNN_k50_k13"                
#> [22] "SNN_k50_k14"                 "SNN_k50_k15"                 "SNN_k50_k16"                
#> [25] "SNN_k50_k17"                 "SNN_k50_k18"                 "SNN_k50_k19"                
#> [28] "SNN_k50_k20"                 "SNN_k50_k21"                 "SNN_k50_k22"                
#> [31] "SNN_k50_k23"                 "SNN_k50_k24"                 "SNN_k50_k25"                
#> [34] "SNN_k50_k26"                 "SNN_k50_k27"                 "SNN_k50_k28"                
#> [37] "GraphBased"                  "Maynard"                     "Martinowich"                
#> [40] "layer_guess"                 "layer_guess_reordered"       "layer_guess_reordered_short"
#> [43] "expr_chrM"                   "expr_chrM_ratio"             "SpatialDE_PCA"              
#> [46] "SpatialDE_pool_PCA"          "HVG_PCA"                     "pseudobulk_PCA"             
#> [49] "markers_PCA"                 "SpatialDE_UMAP"              "SpatialDE_pool_UMAP"        
#> [52] "HVG_UMAP"                    "pseudobulk_UMAP"             "markers_UMAP"               
#> [55] "SpatialDE_PCA_spatial"       "SpatialDE_pool_PCA_spatial"  "HVG_PCA_spatial"            
#> [58] "pseudobulk_PCA_spatial"      "markers_PCA_spatial"         "SpatialDE_UMAP_spatial"     
#> [61] "SpatialDE_pool_UMAP_spatial" "HVG_UMAP_spatial"            "pseudobulk_UMAP_spatial"    
#> [64] "markers_UMAP_spatial"        "spatialLIBD"                 "ManualAnnotation"           
#> [67] "in_tissue"                   "array_row"                   "array_col"

## Visualize a gene
vis_gene(
    spe = spe,
    sampleid = "151673",
    viridis = FALSE
)


## Visualize the estimated number of cells per spot
vis_gene(
    spe = spe,
    sampleid = "151673",
    geneid = "cell_count"
)


## Visualize the fraction of chrM expression per spot
## without the spatial layer
vis_gene(
    spe = spe,
    sampleid = "151673",
    geneid = "expr_chrM_ratio",
    spatial = FALSE
)

As for the color palette, you can either use the color blind friendly palette when viridis = TRUE or a custom palette we determined. Note that if you design your own palette, you have to take into account that values it can be hard to distinguish some colors from the histology set of purple tones that are noticeable when the continuous variable is below or equal to the minCount (in our palettes such points have a 'transparent' color). For more details, check the internal code of vis_gene_p().

6.3 Extract significant genes

Earlier we also ran sig_genes_extract_all() in order to run the shiny web application. However, we didn’t explain the output. If you explore it, you’ll notice that it’s a very long table with several columns.

head(sig_genes)
#> DataFrame with 6 rows and 12 columns
#>         top  model_type        test        gene      stat        pval         fdr gene_index         ensembl
#>   <integer> <character> <character> <character> <numeric>   <numeric>   <numeric>  <integer>     <character>
#> 1         1  enrichment          WM       NDRG1   16.3053 1.25896e-26 2.51372e-22      10404 ENSG00000104419
#> 2         2  enrichment          WM      PTP4A2   16.1469 2.25133e-26 2.51372e-22        487 ENSG00000184007
#> 3         3  enrichment          WM        AQP1   15.9927 3.97849e-26 2.96145e-22       8201 ENSG00000240583
#> 4         4  enrichment          WM       PAQR6   15.1971 7.86258e-25 4.38948e-21       1501 ENSG00000160781
#> 5         5  enrichment          WM      ANP32B   14.9798 1.80183e-24 8.04735e-21      10962 ENSG00000136938
#> 6         6  enrichment          WM        JAM3   14.7413 4.50756e-24 1.67295e-20      12600 ENSG00000166086
#>             in_rows       in_rows_top20                                     results
#>       <IntegerList>       <IntegerList>                             <CharacterList>
#> 1 1,40215,65023,... 1,156337,223320,... WM_top1,WM-Layer1_top20,WM-Layer4_top10,...
#> 2 2,40531,64532,... 2,223323,245661,... WM_top2,WM-Layer4_top13,WM-Layer5_top20,...
#> 3 3,32241,65062,... 3,223314,245643,...   WM_top3,WM-Layer4_top4,WM-Layer5_top2,...
#> 4 4,34318,65863,...     4,245654,267982     WM_top4,WM-Layer5_top13,WM-Layer6_top10
#> 5 5,28964,63931,...     5,223329,267975      WM_top5,WM-Layer4_top19,WM-Layer6_top3
#> 6 6,40868,65917,... 6,156334,223324,... WM_top6,WM-Layer1_top17,WM-Layer4_top14,...

The output of sig_genes_extract_all() contains the following columns:

top: the rank of the gene for the given test.
model_type: either enrichment, pairwise or anova.
test: the short notation for the test performed. For example, WM is white matter versus the other layers while WM-Layer1 is white matter greater than layer 1.
gene: the gene symbol.
stat: the corresponding F or t-statistic.
pval: the corresponding p-value (two-sided for t-stats).
fdr: the FDR adjusted p-value.
gene_index: the row of sce_layer and the original tables in modeling_results to join the tables if necessary.
ensembl: Ensembl gene ID.
in_rows: an IntegerList() specifying all the rows where that gene is present.
in_rows_top20: an IntegerList() specifying all the rows where that gene is present and where its rank (top) is less than or equal to 20. This information is only included for the first occurrence of each gene if that gene is on the top 20 rank for any of the models.
results: an CharacterList() specifying all the test results where the gene is ranked (top) among the top 20 genes.

sig_genes_extract_all() uses sig_genes_extract() as it’s workhorse and as such has a very similar output.

6.4 Visualize modeling results

After extracting the table of modeling results in long format with sig_genes_extract_all(), we can then use layer_boxplot() to visualize any gene of interest for any of the model types and tests we performed. Below we explore the first one (by default). We also show the color palettes used in the shiny application provided by spatialLIBD (Pardo, Spangler, Weber, et al., 2021). The last example has the long title version that uses more information from the sig_genes object we created earlier.

## Note that we recommend setting the random seed so the jittering of the
## points will be reproducible. Given the requirements by BiocCheck this
## cannot be done inside the layer_boxplot() function.

## Create a boxplot of the first gene in `sig_genes`.
set.seed(20200206)
layer_boxplot(sig_genes = sig_genes, sce_layer = sce_layer)


## Viridis colors displayed in the shiny app
## showing the first pairwise model result
## (which illustrates the background colors used for the layers not
## involved in the pairwise comparison)
set.seed(20200206)
layer_boxplot(
    i = which(sig_genes$model_type == "pairwise")[1],
    sig_genes = sig_genes,
    sce_layer = sce_layer,
    col_low_box = viridisLite::viridis(4)[2],
    col_low_point = viridisLite::viridis(4)[1],
    col_high_box = viridisLite::viridis(4)[3],
    col_high_point = viridisLite::viridis(4)[4]
)


## Paper colors displayed in the shiny app
set.seed(20200206)
layer_boxplot(
    sig_genes = sig_genes,
    sce_layer = sce_layer,
    short_title = FALSE,
    col_low_box = "palegreen3",
    col_low_point = "springgreen2",
    col_high_box = "darkorange2",
    col_high_point = "orange1"
)

6.5 Correlation of layer-level statistics

Just like we compressed our spe object into sce_layer by pseudo-bulking 555 For more details, check this script., we can do the same for other single nucleus or single cell RNA sequencing datasets (snRNA-seq, scRNA-seq) and then compute enrichment t-statistics (one group vs the rest; could be one cell type vs the rest or one cluster of cells vs the rest). In our analysis (Maynard, Collado-Torres, Weber, et al., 2021), we did this for several datasets including one of our LIBD Human DLPFC snRNA-seq data generated by Matthew N Tran et al 666 For more details, check this script.. In spatialLIBD (Pardo, Spangler, Weber, et al., 2021) we include a small set of these statistics for the 31 cell clusters identified by Matthew N Tran et al.

## Explore the enrichment t-statistics derived from Tran et al's snRNA-seq
## DLPFC data
dim(tstats_Human_DLPFC_snRNAseq_Nguyen_topLayer)
#> [1] 692  31
tstats_Human_DLPFC_snRNAseq_Nguyen_topLayer[seq_len(3), seq_len(6)]
#>                      2 (1)       4 (1)      6 (1)      8 (1)     10 (1)     12 (1)
#> ENSG00000104419 -0.6720726  0.30024609  0.5854130  0.1358497  0.3981996 -0.9731938
#> ENSG00000184007  0.2535838 -0.28998049 -1.8106052 -0.2096309 -0.4521719 -0.1840286
#> ENSG00000240583 -0.2015831 -0.04053423 -0.5120807  0.1688405 -0.3969257 -0.2086954

The function layer_stat_cor() will take as input one such matrix of statistics and correlate them against our layer enrichment results (or other model types) using the subset of Ensembl gene IDs that are observed in both tables.

## Compute the correlation matrix of enrichment t-statistics between our data
## and Tran et al's snRNA-seq data
cor_stats_layer <- layer_stat_cor(
    tstats_Human_DLPFC_snRNAseq_Nguyen_topLayer,
    modeling_results,
    "enrichment"
)

## Explore the correlation matrix
head(cor_stats_layer[, seq_len(3)])
#>               WM       Layer6     Layer5
#> 22 (3) 0.6824669 -0.009192291 -0.1934265
#> 3 (3)  0.7154122 -0.070042729 -0.2290574
#> 23 (3) 0.6637885 -0.031467704 -0.2018306
#> 17 (3) 0.6364983 -0.094216046 -0.2026147
#> 21 (3) 0.6281443 -0.050336358 -0.1988774
#> 7 (4)  0.1850724 -0.197283175 -0.2716890

Once we have computed this correlation matrix, we can then visualize it using layer_stat_cor_plot() as shown below.

## Visualize the correlation matrix
layer_stat_cor_plot(cor_stats_layer, max = max(cor_stats_layer))

In order to fully interpret the resulting heatmap you need to know what each of the cell clusters labels mean. In this case, the syntax is xx (Y) where xx is the cluster number and Y is:

Excit: excitatory neurons.
Inhib: inhibitory neurons.
Oligo: oligodendrocytes.
Astro: astrocytes.
OPC: oligodendrocyte progenitor cells.
Drop: an ambiguous cluster of cells that potentially should be dropped.

You can find the version with the full names here if you are interested in it.

The shiny application provided by spatialLIBD (Pardo, Spangler, Weber, et al., 2021) allows users to upload CSV file with these t-statistics, view the correlation heatmaps, download them, and download the correlation matrix. An example CSV file is provided here.

6.6 Gene set enrichment

Many researchers have identified lists of genes that increase the risk of a given disorder or disease, are differentially expressed in a given experiment or set of conditions, have been described in a several research papers, among other collections. We can ask for any of our modeling results whether a list of genes is enriched among our significant results.

For illustration purposes, we included in spatialLIBD (Pardo, Spangler, Weber, et al., 2021) a set of genes from the Simons Foundation Autism Research Initiative SFARI. In our analysis (Maynard, Collado-Torres, Weber, et al., 2021) we used more gene lists. Below, we read in the data and create a list() object with the Ensembl gene IDs that SFARI has provided that are related to autism.

## Read in the SFARI gene sets included in the package
asd_sfari <- utils::read.csv(
    system.file(
        "extdata",
        "SFARI-Gene_genes_01-03-2020release_02-04-2020export.csv",
        package = "spatialLIBD"
    ),
    as.is = TRUE
)

## Format them appropriately
asd_sfari_geneList <- list(
    Gene_SFARI_all = asd_sfari$ensembl.id,
    Gene_SFARI_high = asd_sfari$ensembl.id[asd_sfari$gene.score < 3],
    Gene_SFARI_syndromic = asd_sfari$ensembl.id[asd_sfari$syndromic == 1]
)

After reading the list of genes, we can then compute the enrichment odds ratios and p-values for a given FDR threshold in our statistics.

## Compute the gene set enrichment results
asd_sfari_enrichment <- gene_set_enrichment(
    gene_list = asd_sfari_geneList,
    modeling_results = modeling_results,
    model_type = "enrichment"
)

## Explore the results
head(asd_sfari_enrichment)
#>          OR       Pval   test                   ID model_type fdr_cut
#> 1 1.2659915 0.00318733     WM       Gene_SFARI_all enrichment     0.1
#> 2 1.1819109 0.17753833     WM      Gene_SFARI_high enrichment     0.1
#> 3 1.2333378 0.31971056     WM Gene_SFARI_syndromic enrichment     0.1
#> 4 0.9702022 0.85164140 Layer1       Gene_SFARI_all enrichment     0.1
#> 5 0.7192630 0.14735979 Layer1      Gene_SFARI_high enrichment     0.1
#> 6 1.1216176 0.73790069 Layer1 Gene_SFARI_syndromic enrichment     0.1

Using the above enrichment table, we can then visualize the odds ratios on a heatmap as shown below. Note that we use the thresholded p-values at -log10(p) = 12 for visualization purposes and only show the odds ratios for -log10(p) > 3 by default.

## Visualize gene set enrichment results
gene_set_enrichment_plot(
    asd_sfari_enrichment,
    xlabs = gsub(".*_", "", unique(asd_sfari_enrichment$ID)),
    layerHeights = c(0, 40, 55, 75, 85, 110, 120, 135)
)

The shiny application provided by spatialLIBD (Pardo, Spangler, Weber, et al., 2021) allows users to upload CSV file their gene lists, compute the enrichment statistics, visualize them, download the PDF, and download the enrichment table. An example CSV file is provided here.

7 Re-shaping your data to our structure

This section gets into the details of how we generated the data (Maynard, Collado-Torres, Weber, et al., 2021) behind spatialLIBD (Pardo, Spangler, Weber, et al., 2021). This could be useful if you are a Bioconductor developer or a user very familiar with packages such as SingleCellExperiment.

7.1 SpatialExperiment support

As of version 1.3.3, spatialLIBD supports the SpatialExperiment class from SpatialExperiment. The functions vis_gene_p(), vis_gene(), vis_grid_clus(), vis_grid_gene(), vis_clus(), vis_clus_p(), geom_spatial() now work with SpatialExperiment objects thanks to the updates in SpatialExperiment. If you have spot-level data formatted in the older SingleCellExperiment objects that were heavily modified for spatialLIBD, you can use sce_to_spe() to convert the objects.

This work was done by Brenda Pardo and Leonardo.

7.2 Using spatialLIBD with your own data

TODO (but way simpler now thanks to SpatialExperiment.)

7.3 Expected characteristics of the data

If you want to check the key characteristics required by spatialLIBD’s functions or the shiny application, use the check_* family of functions.

check_spe(spe)
#> class: SpatialExperiment 
#> dim: 33538 47681 
#> metadata(0):
#> assays(2): counts logcounts
#> rownames(33538): ENSG00000243485 ENSG00000237613 ... ENSG00000277475 ENSG00000268674
#> rowData names(9): source type ... gene_search is_top_hvg
#> colnames(47681): AAACAACGAATAGTTC-1 AAACAAGTATCTCCCA-1 ... TTGTTTCCATACAACT-1 TTGTTTGTGTAAATTC-1
#> colData names(66): sample_id Cluster ... spatialLIBD ManualAnnotation
#> reducedDimNames(6): PCA TSNE_perplexity50 ... TSNE_perplexity80 UMAP_neighbors15
#> mainExpName: NULL
#> altExpNames(0):
#> spatialData names(3) : in_tissue array_row array_col
#> spatialCoords names(2) : pxl_col_in_fullres pxl_row_in_fullres
#> imgData names(4): sample_id image_id data scaleFactor
check_sce_layer(sce_layer)
#> class: SingleCellExperiment 
#> dim: 22331 76 
#> metadata(0):
#> assays(2): counts logcounts
#> rownames(22331): ENSG00000243485 ENSG00000238009 ... ENSG00000278384 ENSG00000271254
#> rowData names(10): source type ... is_top_hvg is_top_hvg_sce_layer
#> colnames(76): 151507_Layer1 151507_Layer2 ... 151676_Layer6 151676_WM
#> colData names(13): sample_name layer_guess ... layer_guess_reordered_short spatialLIBD
#> reducedDimNames(6): PCA TSNE_perplexity5 ... UMAP_neighbors15 PCAsub
#> mainExpName: NULL
#> altExpNames(0):
## The output here is too long to print
xx <- check_modeling_results(modeling_results)
identical(xx, modeling_results)
#> [1] TRUE

7.4 Generating our data (legacy)

If you are interested in reshaping your data to fit our structure, we do not provide a quick function to do so. That is intentional given the active development by the Bioconductor community for determining the best way to deal with spatial transcriptomics data in general and the 10x Visium data in particular. Having said that, we do have all the steps and reproducibility information documented across several of our analysis (Maynard, Collado-Torres, Weber, et al., 2021) scripts.

reorganize_folder.R available here re-organizes the raw data we were sent by 10x Genomics.
Layer_Notebook.R available here reads in the Visium data and builds a list of RangeSummarizedExperiment() objects from SummarizedExperiment, one per sample (image) that is eventually saved as Human_DLPFC_Visium_processedData_rseList.rda.
convert_sce.R available here reads in Human_DLPFC_Visium_processedData_rseList.rda and builds an initial sce object with image data under metadata(sce)$image which is a single data.frame. Subsetting doesn’t automatically subset the image, so you have to do it yourself when plotting as is done by vis_clus_p() and vis_gene_p(). Having the data from all images in a single object allows you to use the spot-level data from all images to compute clusters and do other similar analyses to the ones you would do with sc/snRNA-seq data. The script creates the Human_DLPFC_Visium_processedData_sce.Rdata file.
sce_scran.R available here then uses scran to read in Human_DLPFC_Visium_processedData_sce.Rdata, compute the highly variable genes (stored in our final sce object at rowData(sce)$is_top_hvg), perform dimensionality reduction (PCA, TSNE, UMAP) and identify clusters using the data from all images. The resulting data is then stored as Human_DLPFC_Visium_processedData_sce_scran.Rdata and is the main object used throughout our analysis code (Maynard, Collado-Torres, Weber, et al., 2021).
make-data_spatialLIBD.R available in the source version of spatialLIBD and online here is the script that reads in Human_DLPFC_Visium_processedData_sce_scran.Rdata as well as some other outputs from our analysis and combines them into the final sce and sce_layer objects provided by spatialLIBD (Pardo, Spangler, Weber, et al., 2021). This script simplifies some operations in order to simplify the code behind the shiny application provided by spatialLIBD.

You don’t necessarily need to do all of this to use the functions provided by spatialLIBD. Note that external to the R objects, for the shiny application provided by spatialLIBD you will need to have the tissue_lowres_image.png image files in a directory structure by sample as shown here in order for the interactive visualizations made with plotly to work.

8 Reproducibility

The spatialLIBD package (Pardo, Spangler, Weber, et al., 2021) was made possible thanks to:

R (R Core Team, 2021)
AnnotationHub (Morgan and Shepherd, 2021)
benchmarkme (Gillespie, 2021)
BiocFileCache (Shepherd and Morgan, 2021)
BiocStyle (Oleś, 2021)
cowplot (Wilke, 2020)
DT (Xie, Cheng, and Tan, 2021)
ExperimentHub (Morgan and Shepherd, 2021)
fields (Douglas Nychka, Reinhard Furrer, John Paige, and Stephan Sain, 2017)
ggplot2 (Wickham, 2016)
golem (Fay, Guyader, Rochette, and Girard, 2021)
IRanges (Lawrence, Huber, Pagès, Aboyoun, Carlson, Gentleman, Morgan, and Carey, 2013)
knitr (Xie, 2014)
plotly (Sievert, 2020)
Polychrome (Coombes, Brock, Abrams, and Abruzzo, 2019)
RColorBrewer (Neuwirth, 2014)
RefManageR (McLean, 2017)
rmarkdown (Allaire, Xie, McPherson, et al., 2021)
S4Vectors (Pagès, Lawrence, and Aboyoun, 2021)
scater (McCarthy, Campbell, Lun, and Willis, 2017)
sessioninfo (Csárdi, core, Wickham, et al., 2018)
SingleCellExperiment (Amezquita, Lun, Becht, Carey, Carpp, Geistlinger, Marini, Rue-Albrecht, Risso, Soneson, Waldron, Pages, Smith, Huber, Morgan, Gottardo, and Hicks, 2020)
shiny (Chang, Cheng, Allaire, et al., 2021)
SpatialExperiment (Righelli, Risso, Crowell, et al., 2021)
SummarizedExperiment (Morgan, Obenchain, Hester, and Pagès, 2021)
testthat (Wickham, 2011)
viridisLite (Garnier, Simon, Ross, Noam, Rudis, Robert, Camargo, Pedro, Sciaini, Marco, Scherer, and Cédric, 2021)

Code for creating the vignette

## Create the vignette
library("rmarkdown")
system.time(render("spatialLIBD.Rmd"))

## Extract the R code
library("knitr")
knit("spatialLIBD.Rmd", tangle = TRUE)

Date the vignette was generated.

#> [1] "2021-05-20 14:49:50 EDT"

Wallclock time spent generating the vignette.

#> Time difference of 34.743 secs

R session information.

#> ─ Session info ───────────────────────────────────────────────────────────────────────────────────────────────────────
#>  setting  value                       
#>  version  R version 4.1.0 (2021-05-18)
#>  os       Ubuntu 20.04.2 LTS          
#>  system   x86_64, linux-gnu           
#>  ui       X11                         
#>  language (EN)                        
#>  collate  C                           
#>  ctype    en_US.UTF-8                 
#>  tz       America/New_York            
#>  date     2021-05-20                  
#> 
#> ─ Packages ───────────────────────────────────────────────────────────────────────────────────────────────────────────
#>  package                * version  date       lib source        
#>  AnnotationDbi            1.54.0   2021-05-19 [2] Bioconductor  
#>  AnnotationHub            3.0.0    2021-05-19 [2] Bioconductor  
#>  assertthat               0.2.1    2019-03-21 [2] CRAN (R 4.1.0)
#>  attempt                  0.3.1    2020-05-03 [2] CRAN (R 4.1.0)
#>  beachmat                 2.8.0    2021-05-19 [2] Bioconductor  
#>  beeswarm                 0.3.1    2021-03-07 [2] CRAN (R 4.1.0)
#>  benchmarkme              1.0.7    2021-03-21 [2] CRAN (R 4.1.0)
#>  benchmarkmeData          1.0.4    2020-04-23 [2] CRAN (R 4.1.0)
#>  Biobase                * 2.52.0   2021-05-19 [2] Bioconductor  
#>  BiocFileCache          * 2.0.0    2021-05-19 [2] Bioconductor  
#>  BiocGenerics           * 0.38.0   2021-05-19 [2] Bioconductor  
#>  BiocIO                   1.2.0    2021-05-19 [2] Bioconductor  
#>  BiocManager              1.30.15  2021-05-11 [2] CRAN (R 4.1.0)
#>  BiocNeighbors            1.10.0   2021-05-19 [2] Bioconductor  
#>  BiocParallel             1.26.0   2021-05-19 [2] Bioconductor  
#>  BiocSingular             1.8.0    2021-05-19 [2] Bioconductor  
#>  BiocStyle              * 2.20.0   2021-05-19 [2] Bioconductor  
#>  BiocVersion              3.13.1   2021-05-19 [2] Bioconductor  
#>  Biostrings               2.60.0   2021-05-19 [2] Bioconductor  
#>  bit                      4.0.4    2020-08-04 [2] CRAN (R 4.1.0)
#>  bit64                    4.0.5    2020-08-30 [2] CRAN (R 4.1.0)
#>  bitops                   1.0-7    2021-04-24 [2] CRAN (R 4.1.0)
#>  blob                     1.2.1    2020-01-20 [2] CRAN (R 4.1.0)
#>  bookdown                 0.22     2021-04-22 [2] CRAN (R 4.1.0)
#>  bslib                    0.2.5.1  2021-05-18 [2] CRAN (R 4.1.0)
#>  cachem                   1.0.5    2021-05-15 [2] CRAN (R 4.1.0)
#>  cli                      2.5.0    2021-04-26 [2] CRAN (R 4.1.0)
#>  codetools                0.2-18   2020-11-04 [2] CRAN (R 4.1.0)
#>  colorspace               2.0-1    2021-05-04 [2] CRAN (R 4.1.0)
#>  config                   0.3.1    2020-12-17 [2] CRAN (R 4.1.0)
#>  cowplot                  1.1.1    2020-12-30 [2] CRAN (R 4.1.0)
#>  crayon                   1.4.1    2021-02-08 [2] CRAN (R 4.1.0)
#>  curl                     4.3.1    2021-04-30 [2] CRAN (R 4.1.0)
#>  data.table               1.14.0   2021-02-21 [2] CRAN (R 4.1.0)
#>  DBI                      1.1.1    2021-01-15 [2] CRAN (R 4.1.0)
#>  dbplyr                 * 2.1.1    2021-04-06 [2] CRAN (R 4.1.0)
#>  DelayedArray             0.18.0   2021-05-19 [2] Bioconductor  
#>  DelayedMatrixStats       1.14.0   2021-05-19 [2] Bioconductor  
#>  desc                     1.3.0    2021-03-05 [2] CRAN (R 4.1.0)
#>  digest                   0.6.27   2020-10-24 [2] CRAN (R 4.1.0)
#>  dockerfiler              0.1.3    2019-03-19 [2] CRAN (R 4.1.0)
#>  doParallel               1.0.16   2020-10-16 [2] CRAN (R 4.1.0)
#>  dotCall64                1.0-1    2021-02-11 [2] CRAN (R 4.1.0)
#>  dplyr                    1.0.6    2021-05-05 [2] CRAN (R 4.1.0)
#>  dqrng                    0.3.0    2021-05-01 [2] CRAN (R 4.1.0)
#>  DropletUtils             1.12.0   2021-05-19 [2] Bioconductor  
#>  DT                       0.18     2021-04-14 [2] CRAN (R 4.1.0)
#>  edgeR                    3.34.0   2021-05-19 [2] Bioconductor  
#>  ellipsis                 0.3.2    2021-04-29 [2] CRAN (R 4.1.0)
#>  evaluate                 0.14     2019-05-28 [2] CRAN (R 4.1.0)
#>  ExperimentHub            2.0.0    2021-05-19 [2] Bioconductor  
#>  fansi                    0.4.2    2021-01-15 [2] CRAN (R 4.1.0)
#>  farver                   2.1.0    2021-02-28 [2] CRAN (R 4.1.0)
#>  fastmap                  1.1.0    2021-01-25 [2] CRAN (R 4.1.0)
#>  fields                   12.3     2021-05-17 [2] CRAN (R 4.1.0)
#>  filelock                 1.0.2    2018-10-05 [2] CRAN (R 4.1.0)
#>  foreach                  1.5.1    2020-10-15 [2] CRAN (R 4.1.0)
#>  fs                       1.5.0    2020-07-31 [2] CRAN (R 4.1.0)
#>  generics                 0.1.0    2020-10-31 [2] CRAN (R 4.1.0)
#>  GenomeInfoDb           * 1.28.0   2021-05-19 [2] Bioconductor  
#>  GenomeInfoDbData         1.2.6    2021-05-20 [2] Bioconductor  
#>  GenomicAlignments        1.28.0   2021-05-19 [2] Bioconductor  
#>  GenomicRanges          * 1.44.0   2021-05-19 [2] Bioconductor  
#>  ggbeeswarm               0.6.0    2017-08-07 [2] CRAN (R 4.1.0)
#>  ggplot2                  3.3.3    2020-12-30 [2] CRAN (R 4.1.0)
#>  glue                     1.4.2    2020-08-27 [2] CRAN (R 4.1.0)
#>  golem                    0.3.1    2021-04-17 [2] CRAN (R 4.1.0)
#>  gridExtra                2.3      2017-09-09 [2] CRAN (R 4.1.0)
#>  gtable                   0.3.0    2019-03-25 [2] CRAN (R 4.1.0)
#>  HDF5Array                1.20.0   2021-05-19 [2] Bioconductor  
#>  highr                    0.9      2021-04-16 [2] CRAN (R 4.1.0)
#>  htmltools                0.5.1.1  2021-01-22 [2] CRAN (R 4.1.0)
#>  htmlwidgets              1.5.3    2020-12-10 [2] CRAN (R 4.1.0)
#>  httpuv                   1.6.1    2021-05-07 [2] CRAN (R 4.1.0)
#>  httr                     1.4.2    2020-07-20 [2] CRAN (R 4.1.0)
#>  interactiveDisplayBase   1.30.0   2021-05-19 [2] Bioconductor  
#>  IRanges                * 2.26.0   2021-05-19 [2] Bioconductor  
#>  irlba                    2.3.3    2019-02-05 [2] CRAN (R 4.1.0)
#>  iterators                1.0.13   2020-10-15 [2] CRAN (R 4.1.0)
#>  jquerylib                0.1.4    2021-04-26 [2] CRAN (R 4.1.0)
#>  jsonlite                 1.7.2    2020-12-09 [2] CRAN (R 4.1.0)
#>  KEGGREST                 1.32.0   2021-05-19 [2] Bioconductor  
#>  knitr                    1.33     2021-04-24 [2] CRAN (R 4.1.0)
#>  labeling                 0.4.2    2020-10-20 [2] CRAN (R 4.1.0)
#>  later                    1.2.0    2021-04-23 [2] CRAN (R 4.1.0)
#>  lattice                  0.20-44  2021-05-02 [2] CRAN (R 4.1.0)
#>  lazyeval                 0.2.2    2019-03-15 [2] CRAN (R 4.1.0)
#>  lifecycle                1.0.0    2021-02-15 [2] CRAN (R 4.1.0)
#>  limma                    3.48.0   2021-05-19 [2] Bioconductor  
#>  locfit                   1.5-9.4  2020-03-25 [2] CRAN (R 4.1.0)
#>  lubridate                1.7.10   2021-02-26 [2] CRAN (R 4.1.0)
#>  magick                   2.7.2    2021-05-02 [2] CRAN (R 4.1.0)
#>  magrittr                 2.0.1    2020-11-17 [2] CRAN (R 4.1.0)
#>  maps                     3.3.0    2018-04-03 [2] CRAN (R 4.1.0)
#>  Matrix                   1.3-3    2021-05-04 [2] CRAN (R 4.1.0)
#>  MatrixGenerics         * 1.4.0    2021-05-19 [2] Bioconductor  
#>  matrixStats            * 0.58.0   2021-01-29 [2] CRAN (R 4.1.0)
#>  memoise                  2.0.0    2021-01-26 [2] CRAN (R 4.1.0)
#>  mime                     0.10     2021-02-13 [2] CRAN (R 4.1.0)
#>  munsell                  0.5.0    2018-06-12 [2] CRAN (R 4.1.0)
#>  pillar                   1.6.1    2021-05-16 [2] CRAN (R 4.1.0)
#>  pkgconfig                2.0.3    2019-09-22 [2] CRAN (R 4.1.0)
#>  pkgload                  1.2.1    2021-04-06 [2] CRAN (R 4.1.0)
#>  plotly                   4.9.3    2021-01-10 [2] CRAN (R 4.1.0)
#>  plyr                     1.8.6    2020-03-03 [2] CRAN (R 4.1.0)
#>  png                      0.1-7    2013-12-03 [2] CRAN (R 4.1.0)
#>  Polychrome               1.2.6    2020-11-11 [2] CRAN (R 4.1.0)
#>  promises                 1.2.0.1  2021-02-11 [2] CRAN (R 4.1.0)
#>  pryr                   * 0.1.4    2018-02-18 [2] CRAN (R 4.1.0)
#>  purrr                    0.3.4    2020-04-17 [2] CRAN (R 4.1.0)
#>  R.methodsS3              1.8.1    2020-08-26 [2] CRAN (R 4.1.0)
#>  R.oo                     1.24.0   2020-08-26 [2] CRAN (R 4.1.0)
#>  R.utils                  2.10.1   2020-08-26 [2] CRAN (R 4.1.0)
#>  R6                       2.5.0    2020-10-28 [2] CRAN (R 4.1.0)
#>  rappdirs                 0.3.3    2021-01-31 [2] CRAN (R 4.1.0)
#>  RColorBrewer             1.1-2    2014-12-07 [2] CRAN (R 4.1.0)
#>  Rcpp                     1.0.6    2021-01-15 [2] CRAN (R 4.1.0)
#>  RCurl                    1.98-1.3 2021-03-16 [2] CRAN (R 4.1.0)
#>  RefManageR             * 1.3.0    2020-11-13 [2] CRAN (R 4.1.0)
#>  remotes                  2.3.0    2021-04-01 [2] CRAN (R 4.1.0)
#>  restfulr                 0.0.13   2017-08-06 [2] CRAN (R 4.1.0)
#>  rhdf5                    2.36.0   2021-05-19 [2] Bioconductor  
#>  rhdf5filters             1.4.0    2021-05-19 [2] Bioconductor  
#>  Rhdf5lib                 1.14.0   2021-05-19 [2] Bioconductor  
#>  rjson                    0.2.20   2018-06-08 [2] CRAN (R 4.1.0)
#>  rlang                    0.4.11   2021-04-30 [2] CRAN (R 4.1.0)
#>  rmarkdown                2.8      2021-05-07 [2] CRAN (R 4.1.0)
#>  roxygen2                 7.1.1    2020-06-27 [2] CRAN (R 4.1.0)
#>  rprojroot                2.0.2    2020-11-15 [2] CRAN (R 4.1.0)
#>  Rsamtools                2.8.0    2021-05-19 [2] Bioconductor  
#>  RSQLite                  2.2.7    2021-04-22 [2] CRAN (R 4.1.0)
#>  rstudioapi               0.13     2020-11-12 [2] CRAN (R 4.1.0)
#>  rsvd                     1.0.5    2021-04-16 [2] CRAN (R 4.1.0)
#>  rtracklayer            * 1.52.0   2021-05-19 [2] Bioconductor  
#>  S4Vectors              * 0.30.0   2021-05-19 [2] Bioconductor  
#>  sass                     0.4.0    2021-05-12 [2] CRAN (R 4.1.0)
#>  ScaledMatrix             1.0.0    2021-05-19 [2] Bioconductor  
#>  scales                   1.1.1    2020-05-11 [2] CRAN (R 4.1.0)
#>  scater                   1.20.0   2021-05-19 [2] Bioconductor  
#>  scatterplot3d            0.3-41   2018-03-14 [2] CRAN (R 4.1.0)
#>  scuttle                  1.2.0    2021-05-19 [2] Bioconductor  
#>  sessioninfo            * 1.1.1    2018-11-05 [2] CRAN (R 4.1.0)
#>  shiny                    1.6.0    2021-01-25 [2] CRAN (R 4.1.0)
#>  shinyWidgets             0.6.0    2021-03-15 [2] CRAN (R 4.1.0)
#>  SingleCellExperiment   * 1.14.0   2021-05-19 [2] Bioconductor  
#>  spam                     2.6-0    2020-12-14 [2] CRAN (R 4.1.0)
#>  sparseMatrixStats        1.4.0    2021-05-19 [2] Bioconductor  
#>  SpatialExperiment      * 1.2.0    2021-05-19 [2] Bioconductor  
#>  spatialLIBD            * 1.4.0    2021-05-20 [1] Bioconductor  
#>  stringi                  1.6.2    2021-05-17 [2] CRAN (R 4.1.0)
#>  stringr                  1.4.0    2019-02-10 [2] CRAN (R 4.1.0)
#>  SummarizedExperiment   * 1.22.0   2021-05-19 [2] Bioconductor  
#>  testthat                 3.0.2    2021-02-14 [2] CRAN (R 4.1.0)
#>  tibble                   3.1.2    2021-05-16 [2] CRAN (R 4.1.0)
#>  tidyr                    1.1.3    2021-03-03 [2] CRAN (R 4.1.0)
#>  tidyselect               1.1.1    2021-04-30 [2] CRAN (R 4.1.0)
#>  usethis                  2.0.1    2021-02-10 [2] CRAN (R 4.1.0)
#>  utf8                     1.2.1    2021-03-12 [2] CRAN (R 4.1.0)
#>  vctrs                    0.3.8    2021-04-29 [2] CRAN (R 4.1.0)
#>  vipor                    0.4.5    2017-03-22 [2] CRAN (R 4.1.0)
#>  viridis                  0.6.1    2021-05-11 [2] CRAN (R 4.1.0)
#>  viridisLite              0.4.0    2021-04-13 [2] CRAN (R 4.1.0)
#>  withr                    2.4.2    2021-04-18 [2] CRAN (R 4.1.0)
#>  xfun                     0.23     2021-05-15 [2] CRAN (R 4.1.0)
#>  XML                      3.99-0.6 2021-03-16 [2] CRAN (R 4.1.0)
#>  xml2                     1.3.2    2020-04-23 [2] CRAN (R 4.1.0)
#>  xtable                   1.8-4    2019-04-21 [2] CRAN (R 4.1.0)
#>  XVector                  0.32.0   2021-05-19 [2] Bioconductor  
#>  yaml                     2.2.1    2020-02-01 [2] CRAN (R 4.1.0)
#>  zlibbioc                 1.38.0   2021-05-19 [2] Bioconductor  
#> 
#> [1] /tmp/RtmpL81vCz/Rinst2744db1c864f6c
#> [2] /home/biocbuild/bbs-3.13-bioc/R/library

9 Bibliography

This vignette was generated using BiocStyle (Oleś, 2021), knitr (Xie, 2014) and rmarkdown (Allaire, Xie, McPherson, et al., 2021) running behind the scenes.

Citations made with RefManageR (McLean, 2017).

[1] J. Allaire, Y. Xie, J. McPherson, et al. rmarkdown: Dynamic Documents for R. R package version 2.8. 2021. URL: https://github.com/rstudio/rmarkdown.

[2] R. Amezquita, A. Lun, E. Becht, et al. “Orchestrating single-cell analysis with Bioconductor”. In: Nature Methods 17 (2020), pp. 137–145. URL: https://www.nature.com/articles/s41592-019-0654-x.

[3] W. Chang, J. Cheng, J. Allaire, et al. shiny: Web Application Framework for R. R package version 1.6.0. 2021. URL: https://CRAN.R-project.org/package=shiny.

[4] K. R. Coombes, G. Brock, Z. B. Abrams, et al. “Polychrome: Creating and Assessing Qualitative Palettes with Many Colors”. In: Journal of Statistical Software, Code Snippets 90.1 (2019), pp. 1–23. DOI: 10.18637/jss.v090.c01.

[5] G. Csárdi, R. core, H. Wickham, et al. sessioninfo: R Session Information. R package version 1.1.1. 2018. URL: https://CRAN.R-project.org/package=sessioninfo.

[6] Douglas Nychka, Reinhard Furrer, John Paige, et al. fields: Tools for spatial data. R package version 12.3. Boulder, CO, USA: University Corporation for Atmospheric Research, 2017. DOI: 10.5065/D6W957CT. URL: https://github.com/NCAR/Fields.

[7] C. Fay, V. Guyader, S. Rochette, et al. golem: A Framework for Robust Shiny Applications. R package version 0.3.1. 2021. URL: https://CRAN.R-project.org/package=golem.

[8] Garnier, Simon, Ross, et al. viridis - Colorblind-Friendly Color Maps for R. R package version 0.4.0. 2021. DOI: 10.5281/zenodo.4679424. URL: https://sjmgarnier.github.io/viridis/.

[9] C. Gillespie. benchmarkme: Crowd Sourced System Benchmarks. R package version 1.0.7. 2021. URL: https://CRAN.R-project.org/package=benchmarkme.

[10] M. Lawrence, W. Huber, H. Pagès, et al. “Software for Computing and Annotating Genomic Ranges”. In: PLoS Computational Biology 9 (8 2013). DOI: 10.1371/journal.pcbi.1003118. URL: http://www.ploscompbiol.org/article/info%3Adoi%2F10.1371%2Fjournal.pcbi.1003118}.

[11] K. R. Maynard, L. Collado-Torres, L. M. Weber, et al. “Transcriptome-scale spatial gene expression in the human dorsolateral prefrontal cortex”. In: Nature Neuroscience (2021). DOI: 10.1038/s41593-020-00787-0. URL: https://www.nature.com/articles/s41593-020-00787-0.

[12] D. J. McCarthy, K. R. Campbell, A. T. L. Lun, et al. “Scater: pre-processing, quality control, normalisation and visualisation of single-cell RNA-seq data in R”. In: Bioinformatics 33 (8 2017), pp. 1179-1186. DOI: 10.1093/bioinformatics/btw777.

[13] M. W. McLean. “RefManageR: Import and Manage BibTeX and BibLaTeX References in R”. In: The Journal of Open Source Software (2017). DOI: 10.21105/joss.00338.

[14] M. Morgan, V. Obenchain, J. Hester, et al. SummarizedExperiment: SummarizedExperiment container. R package version 1.22.0. 2021. URL: https://bioconductor.org/packages/SummarizedExperiment.

[15] M. Morgan and L. Shepherd. AnnotationHub: Client to access AnnotationHub resources. R package version 3.0.0. 2021.

[16] M. Morgan and L. Shepherd. ExperimentHub: Client to access ExperimentHub resources. R package version 2.0.0. 2021.

[17] E. Neuwirth. RColorBrewer: ColorBrewer Palettes. R package version 1.1-2. 2014. URL: https://CRAN.R-project.org/package=RColorBrewer.

[18] A. Oleś. BiocStyle: Standard styles for vignettes and other Bioconductor documents. R package version 2.20.0. 2021. URL: https://github.com/Bioconductor/BiocStyle.

[19] H. Pagès, M. Lawrence, and P. Aboyoun. S4Vectors: Foundation of vector-like and list-like containers in Bioconductor. R package version 0.30.0. 2021. URL: https://bioconductor.org/packages/S4Vectors.

[20] B. Pardo, A. Spangler, L. M. Weber, et al. “spatialLIBD: an R/Bioconductor package to visualize spatially-resolved transcriptomics data”. In: bioRxiv (2021). DOI: 10.1101/2021.04.29.440149. URL: https://www.biorxiv.org/content/10.1101/2021.04.29.440149v1.

[21] R Core Team. R: A Language and Environment for Statistical Computing. R Foundation for Statistical Computing. Vienna, Austria, 2021. URL: https://www.R-project.org/.

[22] D. Righelli, D. Risso, H. Crowell, et al. SpatialExperiment: S4 Class for Spatial Experiments handling. R package version 1.2.0. 2021.

[23] L. Shepherd and M. Morgan. BiocFileCache: Manage Files Across Sessions. R package version 2.0.0. 2021.

[24] C. Sievert. Interactive Web-Based Data Visualization with R, plotly, and shiny. Chapman and Hall/CRC, 2020. ISBN: 9781138331457. URL: https://plotly-r.com.

[25] H. Wickham. ggplot2: Elegant Graphics for Data Analysis. Springer-Verlag New York, 2016. ISBN: 978-3-319-24277-4. URL: https://ggplot2.tidyverse.org.

[26] H. Wickham. “testthat: Get Started with Testing”. In: The R Journal 3 (2011), pp. 5–10. URL: https://journal.r-project.org/archive/2011-1/RJournal_2011-1_Wickham.pdf.

[27] C. Wilke. cowplot: Streamlined Plot Theme and Plot Annotations for ‘ggplot2’. R package version 1.1.1. 2020. URL: https://CRAN.R-project.org/package=cowplot.

[28] Y. Xie. “knitr: A Comprehensive Tool for Reproducible Research in R”. In: Implementing Reproducible Computational Research. Ed. by V. Stodden, F. Leisch and R. D. Peng. ISBN 978-1466561595. Chapman and Hall/CRC, 2014. URL: http://www.crcpress.com/product/isbn/9781466561595.

[29] Y. Xie, J. Cheng, and X. Tan. DT: A Wrapper of the JavaScript Library ‘DataTables’. R package version 0.18. 2021. URL: https://CRAN.R-project.org/package=DT.

Introduction to spatialLIBD

20 May 2021

Package

Contents

1 Welcome

1.1 Study design

1.2 Shiny website mirrors

2 Basics

2.1 Install `spatialLIBD`

2.2 Required knowledge

2.3 Asking for help

2.4 Citing `spatialLIBD`

3 Overview

4 Human DLPFC Visium dataset

4.1 Data specifics

4.2 Downloading the data with `spatialLIBD`

5 Interactively explore the `spatialLIBD` data

6 `spatialLIBD` functions

6.1 Spot-level clusters and discrete variables

6.2 Spot-level genes and continuous variables

6.3 Extract significant genes

6.4 Visualize modeling results

6.5 Correlation of layer-level statistics

6.6 Gene set enrichment

7 Re-shaping your data to our structure

7.1 SpatialExperiment support

7.2 Using spatialLIBD with your own data

7.3 Expected characteristics of the data

7.4 Generating our data (legacy)

8 Reproducibility

9 Bibliography

Introduction to spatialLIBD

20 May 2021

Package

Contents

1 Welcome

1.1 Study design

1.2 Shiny website mirrors

2 Basics

2.1 Install spatialLIBD

2.2 Required knowledge

2.3 Asking for help

2.4 Citing spatialLIBD

3 Overview

4 Human DLPFC Visium dataset

4.1 Data specifics

4.2 Downloading the data with spatialLIBD

5 Interactively explore the spatialLIBD data

6 spatialLIBD functions

6.1 Spot-level clusters and discrete variables

6.2 Spot-level genes and continuous variables

6.3 Extract significant genes

6.4 Visualize modeling results

6.5 Correlation of layer-level statistics

6.6 Gene set enrichment

7 Re-shaping your data to our structure

7.1 SpatialExperiment support

7.2 Using spatialLIBD with your own data

7.3 Expected characteristics of the data

7.4 Generating our data (legacy)

8 Reproducibility

9 Bibliography

2.1 Install `spatialLIBD`

2.4 Citing `spatialLIBD`

4.2 Downloading the data with `spatialLIBD`

5 Interactively explore the `spatialLIBD` data

6 `spatialLIBD` functions