Describing the ExperimentColorMap class
2 December 2024
Package
iSEE 2.19.1
Compiled date: 2024-12-02
Last edited: 2018-03-08
License: MIT + file LICENSE
1 Background
iSEE coordinates the coloration in every plot via the ExperimentColorMap class (Rue-Albrecht et al. 2018).
Colors for samples or features are defined from column or row metadata or assay values using “colormaps”.
Each colormap is a function that takes a single integer argument and returns that number of distinct colors.
The ExperimentColorMap is a container that stores these functions for use within the iSEE() function.
Users can define their own colormaps to customize coloration for specific assays or covariates.
2 Defining colormaps
2.1 Colormaps for continuous variables
For continuous variables, the function will be asked to generate a number of colors (21, by default).
Interpolation will then be performed internally to generate a color gradient.
Users can use existing color scales like viridis::viridis or heat.colors:
# Coloring for log-counts:
logcounts_color_fun <- viridis::viridisIt is also possible to use a function that completely ignores any arguments, and simply returns a fixed number of interpolation points:
# Coloring for FPKMs:
fpkm_color_fun <- function(n){
c("black","brown","red","orange","yellow")
}2.2 Colormaps for categorical variables
For categorical variables, the function should accept the number of levels and return a color per level. Colors are automatically assigned to factor levels in the specified order of the levels.
# Coloring for the 'driver' metadata variable.
driver_color_fun <- function(n){
RColorBrewer::brewer.pal(n, "Set2")
}Alternatively, the function can ignore its arguments and simply return a named vector of colors if users want to specify the color for each level explicitly
It is the user’s responsibility to ensure that all levels are accounted for1 Needless to say, these functions should not be used as shared or global colormaps..
For instance, the following colormap function will only be compatible with factors of two levels, namely "Y" and "N":
# Coloring for the QC metadata variable:
qc_color_fun <- function(n){
qc_colors <- c("forestgreen", "firebrick1")
names(qc_colors) <- c("Y", "N")
qc_colors
}3 The colormap hierarchy
3.2 Searching for colors
When queried for a specific colormap of any type (assay, column data, or row data), the following process takes place:
- A specific individual colormap is looked up in the appropriate slot of the
ExperimentColorMap. - If it is not found, the shared colormap of the appropriate slot is looked up, according to whether the data are categorical or continuous.
- If it is not found, the global colormap is looked up, according to whether the data are categorical or continuous.
- If none of the above colormaps were defined, the
ExperimentColorMapwill revert to the default colormaps.
By default, viridis is used as the default continuous colormap, and hcl is used as the default categorical colormap.
4 Creating the ExperimentColorMap
We store the set of colormap functions in an instance of the ExperimentColorMap class.
Named functions passed as assays, colData, or rowData arguments will be used for coloring data in those slots, respectively.
library(iSEE)
ecm <- ExperimentColorMap(
assays = list(
counts = heat.colors,
logcounts = logcounts_color_fun,
cufflinks_fpkm = fpkm_color_fun
),
colData = list(
passes_qc_checks_s = qc_color_fun,
driver_1_s = driver_color_fun
),
all_continuous = list(
assays = viridis::plasma
)
)
ecm
#> Class: ExperimentColorMap
#> assays(3): counts logcounts cufflinks_fpkm
#> colData(2): passes_qc_checks_s driver_1_s
#> rowData(0):
#> all_discrete(0):
#> all_continuous(1): assaysUsers can change the defaults for all assays or column data by modifying the shared colormaps. Similarly, users can modify the defaults for all continuous or categorical data by modifying the global colormaps. This is demonstrated below for the continuous variables:
ExperimentColorMap(
all_continuous=list( # shared
assays=viridis::plasma,
colData=viridis::inferno
),
global_continuous=viridis::magma # global
)
#> Class: ExperimentColorMap
#> assays(0):
#> colData(0):
#> rowData(0):
#> all_discrete(0):
#> all_continuous(2): assays colData
#> global_continuous(1)5 Benefits
The ExperimentColorMap class offers the following major features:
- A single place to define flexible and lightweight sets of colormaps, that may be saved and reused across sessions and projects outside the app, to apply consistent coloring schemes across entire projects
- A simple interface through accessors
colDataColorMap(colormap, "coldata_name")and settersassayColorMap(colormap, "assay_name") <- colormap_function - An elegant fallback mechanism to consistently return a colormap, even for undefined covariates, including a default categorical and continuous colormap, respectively.
- Three levels of colormaps override: individual, shared within slot (i.e.,
assays,colData,rowData), or shared globally between all categorical or continuous data scales.
Detailed examples on the use of ExperimentColorMap objects are available in the documentation ?ExperimentColorMap, as well as below.
6 Demonstration
Here, we use the allen single-cell RNA-seq data set to demonstrate the use of the ExperimentColorMap class.
Using the sce object that we created previously, we create an iSEE app with the SingleCellExperiment object and the colormap generated above.
app <- iSEE(sce, colormap = ecm)We run this using runApp to open the app on our browser.
shiny::runApp(app)
Now, choose to color cells by Column data and select passes_qc_checks_s.
We will see that all cells that passed QC (Y) are colored “forestgreen”, while the ones that didn’t pass are colored firebrick.
If we color any plot by gene expression, we see that use of counts follows the heat.colors coloring scheme;
use of log-counts follows the viridis coloring scheme;
and use of FPKMs follows the black-to-yellow scheme we defined in fpkm_color_fun.
Session Info
sessionInfo()
#> R Under development (unstable) (2024-10-21 r87258)
#> Platform: x86_64-pc-linux-gnu
#> Running under: Ubuntu 24.04.1 LTS
#>
#> Matrix products: default
#> BLAS: /home/biocbuild/bbs-3.21-bioc/R/lib/libRblas.so
#> LAPACK: /usr/lib/x86_64-linux-gnu/lapack/liblapack.so.3.12.0
#>
#> locale:
#> [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C
#> [3] LC_TIME=en_GB LC_COLLATE=C
#> [5] LC_MONETARY=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8
#> [7] LC_PAPER=en_US.UTF-8 LC_NAME=C
#> [9] LC_ADDRESS=C LC_TELEPHONE=C
#> [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
#>
#> time zone: America/New_York
#> tzcode source: system (glibc)
#>
#> attached base packages:
#> [1] stats4 stats graphics grDevices utils datasets methods
#> [8] base
#>
#> other attached packages:
#> [1] TENxPBMCData_1.25.0 HDF5Array_1.35.2
#> [3] rhdf5_2.51.0 DelayedArray_0.33.3
#> [5] SparseArray_1.7.2 S4Arrays_1.7.1
#> [7] abind_1.4-8 Matrix_1.7-1
#> [9] scater_1.35.0 ggplot2_3.5.1
#> [11] scuttle_1.17.0 scRNAseq_2.21.0
#> [13] iSEE_2.19.1 SingleCellExperiment_1.29.1
#> [15] SummarizedExperiment_1.37.0 Biobase_2.67.0
#> [17] GenomicRanges_1.59.1 GenomeInfoDb_1.43.2
#> [19] IRanges_2.41.1 S4Vectors_0.45.2
#> [21] BiocGenerics_0.53.3 generics_0.1.3
#> [23] MatrixGenerics_1.19.0 matrixStats_1.4.1
#> [25] BiocStyle_2.35.0
#>
#> loaded via a namespace (and not attached):
#> [1] splines_4.5.0 later_1.4.1 BiocIO_1.17.1
#> [4] bitops_1.0-9 filelock_1.0.3 tibble_3.2.1
#> [7] XML_3.99-0.17 lifecycle_1.0.4 httr2_1.0.7
#> [10] doParallel_1.0.17 lattice_0.22-6 ensembldb_2.31.0
#> [13] alabaster.base_1.7.2 magrittr_2.0.3 sass_0.4.9
#> [16] rmarkdown_2.29 jquerylib_0.1.4 yaml_2.3.10
#> [19] httpuv_1.6.15 DBI_1.2.3 RColorBrewer_1.1-3
#> [22] zlibbioc_1.53.0 Rtsne_0.17 purrr_1.0.2
#> [25] AnnotationFilter_1.31.0 RCurl_1.98-1.16 rappdirs_0.3.3
#> [28] circlize_0.4.16 GenomeInfoDbData_1.2.13 ggrepel_0.9.6
#> [31] irlba_2.3.5.1 alabaster.sce_1.7.0 codetools_0.2-20
#> [34] DT_0.33 tidyselect_1.2.1 shape_1.4.6.1
#> [37] UCSC.utils_1.3.0 ScaledMatrix_1.15.0 viridis_0.6.5
#> [40] shinyWidgets_0.8.7 BiocFileCache_2.15.0 GenomicAlignments_1.43.0
#> [43] jsonlite_1.8.9 GetoptLong_1.0.5 BiocNeighbors_2.1.1
#> [46] iterators_1.0.14 foreach_1.5.2 tools_4.5.0
#> [49] Rcpp_1.0.13-1 glue_1.8.0 gridExtra_2.3
#> [52] xfun_0.49 mgcv_1.9-1 dplyr_1.1.4
#> [55] gypsum_1.3.0 shinydashboard_0.7.2 withr_3.0.2
#> [58] BiocManager_1.30.25 fastmap_1.2.0 rhdf5filters_1.19.0
#> [61] fansi_1.0.6 shinyjs_2.1.0 digest_0.6.37
#> [64] rsvd_1.0.5 R6_2.5.1 mime_0.12
#> [67] colorspace_2.1-1 listviewer_4.0.0 RSQLite_2.3.8
#> [70] utf8_1.2.4 rtracklayer_1.67.0 httr_1.4.7
#> [73] htmlwidgets_1.6.4 pkgconfig_2.0.3 gtable_0.3.6
#> [76] blob_1.2.4 ComplexHeatmap_2.23.0 XVector_0.47.0
#> [79] htmltools_0.5.8.1 bookdown_0.41 ProtGenerics_1.39.0
#> [82] rintrojs_0.3.4 clue_0.3-66 scales_1.3.0
#> [85] alabaster.matrix_1.7.3 png_0.1-8 knitr_1.49
#> [88] rjson_0.2.23 nlme_3.1-166 curl_6.0.1
#> [91] shinyAce_0.4.3 cachem_1.1.0 GlobalOptions_0.1.2
#> [94] BiocVersion_3.21.1 parallel_4.5.0 miniUI_0.1.1.1
#> [97] vipor_0.4.7 AnnotationDbi_1.69.0 restfulr_0.0.15
#> [100] pillar_1.9.0 grid_4.5.0 alabaster.schemas_1.7.0
#> [103] vctrs_0.6.5 promises_1.3.2 BiocSingular_1.23.0
#> [106] dbplyr_2.5.0 beachmat_2.23.2 xtable_1.8-4
#> [109] cluster_2.1.6 beeswarm_0.4.0 evaluate_1.0.1
#> [112] GenomicFeatures_1.59.1 cli_3.6.3 compiler_4.5.0
#> [115] Rsamtools_2.23.1 rlang_1.1.4 crayon_1.5.3
#> [118] ggbeeswarm_0.7.2 viridisLite_0.4.2 alabaster.se_1.7.0
#> [121] BiocParallel_1.41.0 munsell_0.5.1 Biostrings_2.75.1
#> [124] lazyeval_0.2.2 colourpicker_1.3.0 ExperimentHub_2.15.0
#> [127] bit64_4.5.2 Rhdf5lib_1.29.0 KEGGREST_1.47.0
#> [130] shiny_1.9.1 alabaster.ranges_1.7.0 AnnotationHub_3.15.0
#> [133] fontawesome_0.5.3 igraph_2.1.1 memoise_2.0.1
#> [136] bslib_0.8.0 bit_4.5.0
# devtools::session_info()