Compiled date: 2021-10-14

Last edited: 2020-04-20

License: MIT + file LICENSE

1 Introduction

iSEE is a Bioconductor package that provides an interactive Shiny-based graphical user interface for exploring data stored in SummarizedExperiment objects (Rue-Albrecht et al. 2018). Instructions to install the package are available here. Once installed, the package can be loaded and attached to your current workspace as follows:

library(iSEE)

If you have a SummarizedExperiment object1 Or an instance of a subclass, like a SingleCellExperiment object. named se, you can launch an iSEE app by running:

iSEE(se)

In this vignette, we demonstrate this process using the allen single-cell RNA-seq data set from the scRNAseq package. However, if you want to start playing with the app immediately, you can simply run:

example(iSEE, ask=FALSE)

2 Setting up the data

The allen data set contains expression values for 379 cells from the mouse visual cortex (Tasic et al. 2016), and can be loaded directly by calling ReprocessedAllenData() and specifying the value for the assays parameter. To begin with, we assign the output of this call to an sce object and inspect it.

library(scRNAseq)
sce <- ReprocessedAllenData(assays = "tophat_counts")   # specifying the assays to speed up the example
sce
#> class: SingleCellExperiment 
#> dim: 20816 379 
#> metadata(2): SuppInfo which_qc
#> assays(1): tophat_counts
#> rownames(20816): 0610007P14Rik 0610009B22Rik ... Zzef1 Zzz3
#> rowData names(0):
#> colnames(379): SRR2140028 SRR2140022 ... SRR2139341 SRR2139336
#> colData names(22): NREADS NALIGNED ... Animal.ID passes_qc_checks_s
#> reducedDimNames(0):
#> mainExpName: endogenous
#> altExpNames(1): ERCC

As provided, the sce object contains raw data and a number of quality control and experimental cell annotations, all available in colData(sce).

colnames(colData(sce))
#>  [1] "NREADS"                       "NALIGNED"                    
#>  [3] "RALIGN"                       "TOTAL_DUP"                   
#>  [5] "PRIMER"                       "PCT_RIBOSOMAL_BASES"         
#>  [7] "PCT_CODING_BASES"             "PCT_UTR_BASES"               
#>  [9] "PCT_INTRONIC_BASES"           "PCT_INTERGENIC_BASES"        
#> [11] "PCT_MRNA_BASES"               "MEDIAN_CV_COVERAGE"          
#> [13] "MEDIAN_5PRIME_BIAS"           "MEDIAN_3PRIME_BIAS"          
#> [15] "MEDIAN_5PRIME_TO_3PRIME_BIAS" "driver_1_s"                  
#> [17] "dissection_s"                 "Core.Type"                   
#> [19] "Primary.Type"                 "Secondary.Type"              
#> [21] "Animal.ID"                    "passes_qc_checks_s"

Then, we normalize the expression values with scater.

library(scater)
sce <- logNormCounts(sce, exprs_values="tophat_counts")

Next, we apply PCA and t-SNE to generate two low-dimensional representations of the cells. The dimensionality reduction results are stored in reducedDim(sce).

set.seed(1000)
sce <- runPCA(sce)
sce <- runTSNE(sce)
reducedDimNames(sce)
#> [1] "PCA"  "TSNE"

At this point, the sce object does not contain any annotations for the rows (i.e., features) in the data set. Thus, to prepare a fully-featured example application, we also add some gene metadata to the rowData related to the mean-variance relationship in the data.

rowData(sce)$mean_log <- rowMeans(logcounts(sce))
rowData(sce)$var_log <- apply(logcounts(sce), 1, var)

It is important to note that iSEE relies primarily on precomputed values stored in the various slots of objects derived from the SummarizedExperiment class2 Except when dealing with custom panels.. This allows users to visualize any metrics of interest, but also requires these to be calculated and added to the object before the initialization of the app. That said, it is straightforward to iteratively explore a precomputed object, take notes of new metrics to compute, close the app, store new results in the SummarizedExperiment object, and launch a new app using the updated object.

3 Launching the interface

To begin the exploration, we create an iSEE app with the SingleCellExperiment object generated above. In its simplest form, the iSEE function only requires the input object. However, iSEE applications can be extensively reconfigured using a number of optional arguments to the iSEE function.

app <- iSEE(sce)

The runApp function launches the app in our browser.

shiny::runApp(app)

By default, the app starts with a dashboard that contains one panel or table of each type. By opening the collapsible panels named “Data parameters”, “Visual parameters”, and “Selection parameters” under each plot, we can control the content and appearance of each panel.

Now, look in the upper right corner for a question mark icon (), and click on the hand button () for an introductory tour. This will perform an interactive tour of the app, based on the rintrojs package (Ganz 2016). During this tour, you will be taken through the different components of the iSEE user interface and learn the basic usage mechanisms by doing small actions guided by the tutorial: the highlighted elements will be responding to your actions, while the rest of the UI will be shaded. You can move forward and backward along the tour by clicking on the “Next”/“Back” buttons, or also using the arrow keys. You can even jump to a particular step by clicking on its circle. To exit the tour, either click on “Skip”, or simply click outside of the highlighted UI element.

Once you are done generating plots, click on the export icon () in the upper right corner, and click on the magic wand button () to display R code that you can export and directly re-use in your R session. This will open a modal popup where the R code used to generate the plots is displayed in a shinyAce-based text editor. Select parts or all of it to copy-and-paste it into your analysis script/Rmarkdown file. However, note that the order in which the code blocks are reported is important if you have linked panels to one another, as the panels sending point selections must be executed before those that receive the corresponding selection.

4 Description of the user interface

4.2 Body

4.2.1 Overview of panel types

The main element in the body of iSEE is the combination of panels, generated (and optionally linked to one another) according to your actions. There are currently eight standard panel types that can be generated with iSEE:

  • Reduced dimension plot
  • Column data table
  • Column data plot
  • Feature assay plot
  • Row data table
  • Row data plot
  • Sample assay plot
  • Complex heatmap

In addition, custom panel types can be defined as described in a separate dedicated vignette. The panels and models in the iSEEu package provide additional flexibility.

For each standard plot panel, three different sets of parameters will be available in collapsible boxes:

  • “Data parameters”, to control parameters specific to each type of plot.
  • “Visual parameters”, to specify parameters that will determine the aspect of the plot, in terms of coloring, point features, and more (e.g., legend placement, font size).
  • “Selection parameters” to control the incoming point selection and link relationships to other plots.

4.2.2 Reduced dimension plots

If a SingleCellExperiment object is supplied to the iSEE function, reduced dimension results are extracted from the reducedDim slot. Examples include low-dimensional embeddings from principal components analysis (PCA) or t-distributed stochastic neighbour embedding (t-SNE) (Van der Maaten and Hinton 2008). These results are used to construct a two-dimensional Reduced dimension plot where each point is a sample, to facilitate efficient exploration of high-dimensional datasets. The “Data parameters” control the reducedDim slot to be displayed, as well as the two dimensions to plot against each other.

Note that this builtin panel does not compute reduced dimension embeddings; they must be precomputed and available in the object provided to the iSEE function. Nevertheless, custom panels - such as the iSEEu DynamicReducedDimensionPlot can be developed and used to enable such features.

4.2.3 Column data plots

A Column data plot visualizes sample metadata stored in the SummarizedExperiment column metadata. Different fields can be used for the x- and y-axes by selecting appropriate values in the “Data parameters” box. This plot can assume various forms, depending on the nature of the data on the x- and y-axes:

  • If the y-axis is continuous and the x-axis is categorical, violin plots are generated (grouped by the x-axis factor).
  • If the y-axis is categorical and the x-axis is continuous, horizontal violin plots are generated (grouped by the y-axis factor).
  • If both axes are continuous, a scatter plot is generated. This enables the use of contours that are overlaid on top of the plot, check the "Other" box to see the available options.
  • If both axes are categorical, a plot of squares (Hinton plot) is generated where the area of each square is proportional to the number of samples within each combination of factor levels.

Note that an x-axis setting of “None” is considered to be categorical with a single level.

4.2.4 Feature assay plots

A Feature assay plot visualizes the assayed values (e.g., gene expression) for a particular feature (e.g., gene) across the samples on the y-axis. This usually results in a (grouped) violin plot, if the x-axis is set to "None" or a categorical variable; or a scatter plot, if the x-axis is another continuous variable3 That said, if there are categorical values for the assayed values, these will be handled as described in the column data plots..

Gene selection for the y-axis can be achieved by using a linked row data table in another panel. Clicking on a row in the table automatically changes the assayed values plotted on the y-axis. Alternatively, the row name can be directly entered as text that corresponds to an entry of rownames(se)4 This is not effective if se does not contain row names..

The x-axis covariate can also be selected from the plotting parameters. This can be "None", sample metadata, or the assayed values of another feature (also identified using a linked table or via text). The measurement units are selected as one of the assays(se), which is applied to both the X and Y axes.

Obviously, any other assayed value for any feature can be visualized in this manner, not limited to the expression of genes. The only requirement for this type of panel is that the observations can be stored as a matrix in the SummarizedExperiment object.

4.2.5 Row data plots

A Row data plot allows the visualization of information stored in the rowData slot of a SummarizedExperiment object. Its behavior mirrors the implementation for the Column data plot, and correspondingly this plot can assume various forms depending on whether the data are categorical or continuous.

4.2.6 Sample assay plots

A Sample assay plot visualizes the assayed values (e.g., gene expression) for a particular sample (e.g., cell) across the features on the y-axis.

This usually results in a (grouped) violin plot, if the x-axis is set to "None" or a categorical variable (e.g., gene biotype); or a scatter plot, if the x-axis is another continuous variable.

Notably, the x-axis covariate can also be set to:

  • A discrete row data covariates (e.g., gene biotype), to stratify the distribution of assayed values
  • A continuous row data covariate (e.g., count of cells expressing each gene)
  • Another sample, to visualize and compare the assayed values in any two samples.

4.2.7 Row data tables

A Row data table contains the values of the rowData slot for the SingleCellExperiment/SummarizedExperiment object. If none are available, a column named Present is added and set to TRUE for all features, to avoid issues with DT::datatable and an empty DataFrame. Typically, these tables are used to link to other plots to determine the features to use for plotting or coloring. However, they can also be used to retrieve gene-specific annotation on the fly by specifying the annotFun parameter, e.g. using the annotateEntrez or annotateEnsembl functions, provided in iSEE. Alternatively, users can create a customized annotation function; for more details on this, please consult the manual pages ?annotateEntrez and ?annotateEnsembl.

4.2.8 Column data tables

A Column data table contains the values of the colData slot for the SingleCellExperiment/SummarizedExperiment object. Its behavior mirrors the implementation for the Row data table. Correspondingly, if none are available, a column named Present is added and set to TRUE for all samples, to avoid issues with DT::datatable and an empty DataFrame. Typically, these tables are used to link to other plots to determine the samples to use for plotting or coloring.

4.2.9 Heat maps

Heat map panels provide a compact overview of the data for multiple features in the form of color-coded matrices. These correspond to the assays stored in the SummarizedExperiment object, where features (e.g., genes) are the rows and samples are the columns.

User can select features (rows) to display from the selectize widget (which supports autocompletion), or also via other panels, like row data plots or row data tables. In addition, users can rapidly import custom lists of feature names using a modal popup that provides an Ace editor where they can directly type of paste feature names, and a file upload button that accepts text files containing one feature name per line. Users should remember to click the “Apply” button before closing the modal, to update the heat map with the new list of features.

The “Suggest feature order” button clusters the rows, and also rearranges the elements in the selectize according to the clustering. It is also possible to choose which assay type is displayed ("logcounts" being the default choice, if available). Samples in the heat map can also be annotated, simply by selecting relevant column metadata. A zooming functionality is also available, restricted to the y-axis (i.e., allowing closer inspection on the individual features included).

5 Description of iSEE functionality

5.1 Coloring plots by sample attributes

Column-based plots are the reduced dimension, feature assay and column data plots, where each data point represents a sample. Here, data points can be colored in different ways:

  • The default is no color scheme ("None" in the radio button). This results in data points of a constant user-specified color.
  • Any column of colData(se) can be used. The plot automatically adjusts the scale to use based on whether the chosen column is continuous or categorical.
  • The assay values of a particular feature in each sample can be used. The feature can be chosen either via a linked row table or selectize input (as described for the Feature assay plot panel). Users can also specify the assays from which values are extracted.
  • The identity of a particular sample can be used, which will be highlighted on the plot in a user-specified color. The sample can be chosen either via a linked column table or via a selectize input.

For row-based plots (i.e., the sample assay and row data plots), each data point represents a feature. Like the column-based plots, data points can be colored by:

  • "None", yielding data points of fixed color.
  • Any column of rowData(se).
  • The identity of a particular feature, which is highlighted in the user-specified color.
  • Assay values for a particular sample.

Fine control of the color maps is possible through the ExperimentColorMap class, see this vignette for more details.

5.2 Controlling point aesthetics

Data points can be set to different shapes according to categorical factors in colData(se) (for column-based plots) or rowData(se) (for row-based plots). This is achieved by checking the "Shape" box to reveal the shape-setting options. The size and opacity of the data points can be modified via the options available by checking the "Point" box. This may be useful for aesthetically pleasing visualizations when the number of points is very large or small.

5.3 Faceting

Each point-based plot can be split into multiple facets using the options in the "Facet" checkbox. Users can facet by row and/or column, using categorical factors in colData(se) (for column-based plots) or rowData(se) (for row-based plots). This provides a convenient way to stratify points in a single plot by multiple factors of interest. Note that point selection can only occur within a single facet at a time; points cannot be selected across facets.

5.4 Zooming in and out

Zooming in is possible by first selecting a region of interest in a plot using the brush (drag and select); double-clicking on the brushed area then zooms into the selected area. To zoom out to the original plot, simply double-click at any location in the plot.

6 FAQ

Q: Can you implement a ‘Copy to clipboard’ button in the code editor?

A: This is not necessary, as one can click anywhere in the code editor and instantly select all the code using a keyboard shortcut that depends on your operating system.

Q: When brushing with a transparency effect, it seems that data points in the receiving plot are not made transparent/subsetted correctly.

A: What you see is an artefact of overplotting: in areas excessively dense in points, transparency ceases to be an effective visual effect.

Q: Brushing on violin or square plots doesn’t seem to select anything.

A: For violin plots, points will be selected only if the brushed area includes the center of the x-tick, i.e., the center of the violin plot. This is intentional as it allows easy selection of all points in complex grouped violin plots. Indeed, the location of a specific point on the x-axis has no meaning. The same logic applies to the square plots, where only the center of each square needs to be selected to obtain all the points in the square.

Q: I’d like to try iSEE but I can’t install it/I just want a quick peek. Is there something you can do?

A: We set up an instance of iSEE running on the allen dataset at this address: http://shiny.imbei.uni-mainz.de:3838/iSEE. A range of interactive tours showcasing a variety of data types is also available here: https://github.com/iSEE/iSEE2018. Please keep in mind this is only for demonstration purposes, yet those instances show how you or your system administrator can setup iSEE for analyzing and/or sharing your SummarizedExperiment/SingleCellExperiment precomputed object.

Q: I would like to use iSEE with my Seurat object, how do I do?

A: The Seurat package provides as.SingleCellExperiment() to coerce Seurat objects to SingleCellExperiment objects. This conversion includes assays, cell metadata, feature metadata, and dimensionality reduction results. You can then use the SingleCellExperiment object as usual.

7 Additional information

Bug reports can be posted on the Bioconductor support site or raised as issues in the iSEE GitHub repository. The GitHub repository also contains the development version of the package, where new functionality is added over time. The authors appreciate well-considered suggestions for improvements or new features, or even better, pull requests.

If you use iSEE for your analysis, please cite it as shown below:

citation("iSEE")
#> 
#> Rue-Albrecht K, Marini F, Soneson C, Lun ATL (2018). "iSEE: Interactive
#> SummarizedExperiment Explorer." _F1000Research_, *7*, 741. doi:
#> 10.12688/f1000research.14966.1 (URL:
#> https://doi.org/10.12688/f1000research.14966.1).
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Article{,
#>     title = {iSEE: Interactive SummarizedExperiment Explorer},
#>     author = {Kevin Rue-Albrecht and Federico Marini and Charlotte Soneson and Aaron T. L. Lun},
#>     publisher = {F1000 Research, Ltd.},
#>     journal = {F1000Research},
#>     year = {2018},
#>     month = {Jun},
#>     volume = {7},
#>     pages = {741},
#>     doi = {10.12688/f1000research.14966.1},
#>   }

Session Info

sessionInfo()
#> R version 4.1.1 (2021-08-10)
#> Platform: x86_64-w64-mingw32/x64 (64-bit)
#> Running under: Windows Server x64 (build 17763)
#> 
#> Matrix products: default
#> 
#> locale:
#> [1] LC_COLLATE=C                          
#> [2] LC_CTYPE=English_United States.1252   
#> [3] LC_MONETARY=English_United States.1252
#> [4] LC_NUMERIC=C                          
#> [5] LC_TIME=English_United States.1252    
#> 
#> attached base packages:
#> [1] stats4    stats     graphics  grDevices utils     datasets  methods  
#> [8] base     
#> 
#> other attached packages:
#>  [1] scater_1.21.8               ggplot2_3.3.5              
#>  [3] scuttle_1.3.1               scRNAseq_2.7.2             
#>  [5] iSEE_2.5.3                  SingleCellExperiment_1.15.2
#>  [7] SummarizedExperiment_1.23.5 Biobase_2.53.0             
#>  [9] GenomicRanges_1.45.0        GenomeInfoDb_1.29.8        
#> [11] IRanges_2.27.2              S4Vectors_0.31.5           
#> [13] BiocGenerics_0.39.2         MatrixGenerics_1.5.4       
#> [15] matrixStats_0.61.0          BiocStyle_2.21.4           
#> 
#> loaded via a namespace (and not attached):
#>   [1] circlize_0.4.13               AnnotationHub_3.1.6          
#>   [3] BiocFileCache_2.1.1           igraph_1.2.6                 
#>   [5] lazyeval_0.2.2                shinydashboard_0.7.2         
#>   [7] splines_4.1.1                 BiocParallel_1.27.17         
#>   [9] digest_0.6.28                 ensembldb_2.17.4             
#>  [11] foreach_1.5.1                 htmltools_0.5.2              
#>  [13] viridis_0.6.2                 fansi_0.5.0                  
#>  [15] magrittr_2.0.1                memoise_2.0.0                
#>  [17] ScaledMatrix_1.1.0            cluster_2.1.2                
#>  [19] doParallel_1.0.16             ComplexHeatmap_2.9.4         
#>  [21] Biostrings_2.61.2             prettyunits_1.1.1            
#>  [23] colorspace_2.0-2              blob_1.2.2                   
#>  [25] rappdirs_0.3.3                ggrepel_0.9.1                
#>  [27] xfun_0.26                     dplyr_1.0.7                  
#>  [29] crayon_1.4.1                  RCurl_1.98-1.5               
#>  [31] jsonlite_1.7.2                iterators_1.0.13             
#>  [33] glue_1.4.2                    gtable_0.3.0                 
#>  [35] zlibbioc_1.39.0               XVector_0.33.0               
#>  [37] GetoptLong_1.0.5              DelayedArray_0.19.4          
#>  [39] BiocSingular_1.9.1            shape_1.4.6                  
#>  [41] scales_1.1.1                  DBI_1.1.1                    
#>  [43] miniUI_0.1.1.1                Rcpp_1.0.7                   
#>  [45] viridisLite_0.4.0             xtable_1.8-4                 
#>  [47] progress_1.2.2                clue_0.3-60                  
#>  [49] rsvd_1.0.5                    bit_4.0.4                    
#>  [51] DT_0.19                       htmlwidgets_1.5.4            
#>  [53] httr_1.4.2                    RColorBrewer_1.1-2           
#>  [55] shinyAce_0.4.1                ellipsis_0.3.2               
#>  [57] pkgconfig_2.0.3               XML_3.99-0.8                 
#>  [59] sass_0.4.0                    dbplyr_2.1.1                 
#>  [61] utf8_1.2.2                    tidyselect_1.1.1             
#>  [63] rlang_0.4.11                  later_1.3.0                  
#>  [65] AnnotationDbi_1.55.1          munsell_0.5.0                
#>  [67] BiocVersion_3.14.0            tools_4.1.1                  
#>  [69] cachem_1.0.6                  generics_0.1.0               
#>  [71] RSQLite_2.2.8                 ExperimentHub_2.1.4          
#>  [73] rintrojs_0.3.0                evaluate_0.14                
#>  [75] stringr_1.4.0                 fastmap_1.1.0                
#>  [77] yaml_2.2.1                    knitr_1.36                   
#>  [79] bit64_4.0.5                   purrr_0.3.4                  
#>  [81] AnnotationFilter_1.17.1       KEGGREST_1.33.0              
#>  [83] sparseMatrixStats_1.5.3       nlme_3.1-153                 
#>  [85] mime_0.12                     xml2_1.3.2                   
#>  [87] biomaRt_2.49.4                compiler_4.1.1               
#>  [89] beeswarm_0.4.0                filelock_1.0.2               
#>  [91] curl_4.3.2                    png_0.1-7                    
#>  [93] interactiveDisplayBase_1.31.2 tibble_3.1.5                 
#>  [95] bslib_0.3.1                   stringi_1.7.5                
#>  [97] highr_0.9                     GenomicFeatures_1.45.2       
#>  [99] lattice_0.20-45               ProtGenerics_1.25.1          
#> [101] Matrix_1.3-4                  shinyjs_2.0.0                
#> [103] vctrs_0.3.8                   pillar_1.6.3                 
#> [105] lifecycle_1.0.1               BiocManager_1.30.16          
#> [107] jquerylib_0.1.4               GlobalOptions_0.1.2          
#> [109] BiocNeighbors_1.11.0          irlba_2.3.3                  
#> [111] bitops_1.0-7                  rtracklayer_1.53.1           
#> [113] httpuv_1.6.3                  BiocIO_1.3.0                 
#> [115] R6_2.5.1                      bookdown_0.24                
#> [117] promises_1.2.0.1              gridExtra_2.3                
#> [119] vipor_0.4.5                   codetools_0.2-18             
#> [121] colourpicker_1.1.1            assertthat_0.2.1             
#> [123] fontawesome_0.2.2             rjson_0.2.20                 
#> [125] withr_2.4.2                   shinyWidgets_0.6.2           
#> [127] GenomicAlignments_1.29.0      Rsamtools_2.9.1              
#> [129] GenomeInfoDbData_1.2.7        mgcv_1.8-38                  
#> [131] parallel_4.1.1                hms_1.1.1                    
#> [133] beachmat_2.9.1                grid_4.1.1                   
#> [135] DelayedMatrixStats_1.15.4     rmarkdown_2.11               
#> [137] Rtsne_0.15                    shiny_1.7.1                  
#> [139] ggbeeswarm_0.6.0              restfulr_0.0.13

References

Ganz, C. 2016. “rintrojs: A Wrapper for the Intro.js Library.” Journal of Open Source Software 1 (6). http://dx.doi.org/10.21105/joss.00063.

Rue-Albrecht, K., F. Marini, C. Soneson, and A. T. L. Lun. 2018. “ISEE: Interactive Summarizedexperiment Explorer.” F1000Research 7 (June): 741.

Tasic, B., V. Menon, T. N. Nguyen, T. K. Kim, T. Jarsky, Z. Yao, B. Levi, et al. 2016. “Adult mouse cortical cell taxonomy revealed by single cell transcriptomics.” Nat. Neurosci. 19 (2): 335–46.

Van der Maaten, L., and G. Hinton. 2008. “Visualizing Data Using T-SNE.” J. Mach. Learn. Res. 9 (2579-2605): 85.