Introduction to iSEEde
1 May 2024
Package
iSEEde 1.2.0
1 Basics
1.1 Install iSEEde
is an open-source statistical environment which can be easily modified to enhance its functionality via packages. iSEEde is an package available via the Bioconductor repository for packages. can be installed on any operating system from CRAN after which you can install iSEEde by using the following commands in your session:
if (!requireNamespace("BiocManager", quietly = TRUE)) {
install.packages("BiocManager")
}
BiocManager::install("iSEEde")
## Check that you have a valid Bioconductor installation
BiocManager::valid()1.2 Required knowledge
iSEEde is based on many other packages and in particular on those that have implemented the infrastructure needed for dealing with omics data and interactive visualisation. That is, packages like SummarizedExperiment, SingleCellExperiment, iSEE and shiny.
If you are asking yourself the question “Where do I start using Bioconductor?” you might be interested in this blog post.
1.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 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: remember to use the iSEEde tag and
check
the older posts.
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.
1.4 Citing iSEEde
We hope that iSEEde will be useful for your research. Please use the following information to cite the package and the overall approach. Thank you!
## Citation info
citation("iSEEde")
#> To cite package 'iSEEde' in publications use:
#>
#> Rue-Albrecht K (2024). _iSEEde: iSEE extension for panels related to differential
#> expression analysis_. R package version 1.2.0, <https://github.com/iSEE/iSEEde>.
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Manual{,
#> title = {iSEEde: iSEE extension for panels related to differential expression analysis},
#> author = {Kevin Rue-Albrecht},
#> year = {2024},
#> note = {R package version 1.2.0},
#> url = {https://github.com/iSEE/iSEEde},
#> }2 Quick start to using to iSEEde
The example below demonstrates how to use iSEEde functionality in a simple differential expression workflow.
Specifically, the DESeq2 package is used to perform a simple differential expression analysis.
Then, the results of one contrast – extracted using the function DESeq2::results() function – are embedded into the SummarizedExperiment object airway using the function iSEEde::embedContrastResults().
This ensures that the differential expression results for that contrast are accessible to specialised interactive panels in iSEE applications.
library("iSEEde")
library("airway")
library("DESeq2")
library("iSEE")
# Example data ----
data("airway")
airway$dex <- relevel(airway$dex, "untrt")
dds <- DESeqDataSet(airway, ~ 0 + dex + cell)
dds <- DESeq(dds)
res_deseq2 <- results(dds, contrast = list("dextrt", "dexuntrt"))
head(res_deseq2)
#> log2 fold change (MLE): dextrt vs dexuntrt
#> Wald test p-value: dextrt vs dexuntrt
#> DataFrame with 6 rows and 6 columns
#> baseMean log2FoldChange lfcSE stat pvalue padj
#> <numeric> <numeric> <numeric> <numeric> <numeric> <numeric>
#> ENSG00000000003 708.602170 -0.3812539 0.100654 -3.787752 0.000152016 0.00128292
#> ENSG00000000005 0.000000 NA NA NA NA NA
#> ENSG00000000419 520.297901 0.2068127 0.112219 1.842944 0.065337213 0.19646961
#> ENSG00000000457 237.163037 0.0379205 0.143445 0.264356 0.791505314 0.91141884
#> ENSG00000000460 57.932633 -0.0881679 0.287142 -0.307054 0.758802543 0.89500551
#> ENSG00000000938 0.318098 -1.3782416 3.499906 -0.393794 0.693733216 NA
# iSEE / iSEEde ---
airway <- embedContrastResults(res_deseq2, airway, name = "dex: trt vs untrt")
contrastResults(airway)
#> DataFrame with 63677 rows and 1 column
#> dex: trt vs untrt
#> <iSEEDESeq2Results>
#> ENSG00000000003 <iSEEDESeq2Results>
#> ENSG00000000005 <iSEEDESeq2Results>
#> ENSG00000000419 <iSEEDESeq2Results>
#> ENSG00000000457 <iSEEDESeq2Results>
#> ENSG00000000460 <iSEEDESeq2Results>
#> ... ...
#> ENSG00000273489 <iSEEDESeq2Results>
#> ENSG00000273490 <iSEEDESeq2Results>
#> ENSG00000273491 <iSEEDESeq2Results>
#> ENSG00000273492 <iSEEDESeq2Results>
#> ENSG00000273493 <iSEEDESeq2Results>
app <- iSEE(airway, initial = list(
DETable(ContrastName="dex: trt vs untrt", HiddenColumns = c("baseMean",
"lfcSE", "stat"), PanelWidth = 4L),
VolcanoPlot(ContrastName="dex: trt vs untrt", PanelWidth = 4L),
MAPlot(ContrastName="dex: trt vs untrt", PanelWidth = 4L)
))
if (interactive()) {
shiny::runApp(app)
}
3 Reproducibility
The iSEEde package (Rue-Albrecht, 2024) was made possible thanks to:
- R (R Core Team, 2024)
- BiocStyle (Oleś, 2024)
- knitr (Xie, 2024)
- RefManageR (McLean, 2017)
- rmarkdown (Allaire, Xie, Dervieux et al., 2024)
- sessioninfo (Wickham, Chang, Flight et al., 2021)
- testthat (Wickham, 2011)
This package was developed using biocthis.
Code for creating the vignette
## Create the vignette
library("rmarkdown")
system.time(render("iSEEde.Rmd", "BiocStyle::html_document"))
## Extract the R code
library("knitr")
knit("iSEEde.Rmd", tangle = TRUE)Date the vignette was generated.
#> [1] "2024-05-01 00:20:03 EDT"Wallclock time spent generating the vignette.
#> Time difference of 19.395 secssession information.
#> ─ Session info ───────────────────────────────────────────────────────────────────────────────────────────────────────
#> setting value
#> version R version 4.4.0 beta (2024-04-15 r86425)
#> os Ubuntu 22.04.4 LTS
#> system x86_64, linux-gnu
#> ui X11
#> language (EN)
#> collate en_US.UTF-8
#> ctype en_US.UTF-8
#> tz America/New_York
#> date 2024-05-01
#> pandoc 2.7.3 @ /usr/bin/ (via rmarkdown)
#>
#> ─ Packages ───────────────────────────────────────────────────────────────────────────────────────────────────────────
#> package * version date (UTC) lib source
#> abind 1.4-5 2016-07-21 [2] CRAN (R 4.4.0)
#> airway * 1.23.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> AnnotationDbi * 1.66.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> backports 1.4.1 2021-12-13 [2] CRAN (R 4.4.0)
#> beachmat 2.20.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> bibtex 0.5.1 2023-01-26 [2] CRAN (R 4.4.0)
#> Biobase * 2.64.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> BiocGenerics * 0.50.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> BiocManager 1.30.22 2023-08-08 [2] CRAN (R 4.4.0)
#> BiocParallel 1.38.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> BiocStyle * 2.32.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> Biostrings 2.72.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> bit 4.0.5 2022-11-15 [2] CRAN (R 4.4.0)
#> bit64 4.0.5 2020-08-30 [2] CRAN (R 4.4.0)
#> blob 1.2.4 2023-03-17 [2] CRAN (R 4.4.0)
#> bookdown 0.39 2024-04-15 [2] CRAN (R 4.4.0)
#> bslib 0.7.0 2024-03-29 [2] CRAN (R 4.4.0)
#> cachem 1.0.8 2023-05-01 [2] CRAN (R 4.4.0)
#> circlize 0.4.16 2024-02-20 [2] CRAN (R 4.4.0)
#> cli 3.6.2 2023-12-11 [2] CRAN (R 4.4.0)
#> clue 0.3-65 2023-09-23 [2] CRAN (R 4.4.0)
#> cluster 2.1.6 2023-12-01 [3] CRAN (R 4.4.0)
#> codetools 0.2-20 2024-03-31 [3] CRAN (R 4.4.0)
#> colorspace 2.1-0 2023-01-23 [2] CRAN (R 4.4.0)
#> colourpicker 1.3.0 2023-08-21 [2] CRAN (R 4.4.0)
#> ComplexHeatmap 2.20.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> crayon 1.5.2 2022-09-29 [2] CRAN (R 4.4.0)
#> DBI 1.2.2 2024-02-16 [2] CRAN (R 4.4.0)
#> DelayedArray 0.30.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> DelayedMatrixStats 1.26.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> DESeq2 * 1.44.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> digest 0.6.35 2024-03-11 [2] CRAN (R 4.4.0)
#> doParallel 1.0.17 2022-02-07 [2] CRAN (R 4.4.0)
#> dplyr 1.1.4 2023-11-17 [2] CRAN (R 4.4.0)
#> DT 0.33 2024-04-04 [2] CRAN (R 4.4.0)
#> edgeR * 4.2.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> evaluate 0.23 2023-11-01 [2] CRAN (R 4.4.0)
#> fansi 1.0.6 2023-12-08 [2] CRAN (R 4.4.0)
#> fastmap 1.1.1 2023-02-24 [2] CRAN (R 4.4.0)
#> fontawesome 0.5.2 2023-08-19 [2] CRAN (R 4.4.0)
#> foreach 1.5.2 2022-02-02 [2] CRAN (R 4.4.0)
#> generics 0.1.3 2022-07-05 [2] CRAN (R 4.4.0)
#> GenomeInfoDb * 1.40.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> GenomeInfoDbData 1.2.12 2024-04-16 [2] Bioconductor
#> GenomicRanges * 1.56.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> GetoptLong 1.0.5 2020-12-15 [2] CRAN (R 4.4.0)
#> ggplot2 3.5.1 2024-04-23 [2] CRAN (R 4.4.0)
#> ggrepel 0.9.5 2024-01-10 [2] CRAN (R 4.4.0)
#> GlobalOptions 0.1.2 2020-06-10 [2] CRAN (R 4.4.0)
#> glue 1.7.0 2024-01-09 [2] CRAN (R 4.4.0)
#> gtable 0.3.5 2024-04-22 [2] CRAN (R 4.4.0)
#> highr 0.10 2022-12-22 [2] CRAN (R 4.4.0)
#> htmltools 0.5.8.1 2024-04-04 [2] CRAN (R 4.4.0)
#> htmlwidgets 1.6.4 2023-12-06 [2] CRAN (R 4.4.0)
#> httpuv 1.6.15 2024-03-26 [2] CRAN (R 4.4.0)
#> httr 1.4.7 2023-08-15 [2] CRAN (R 4.4.0)
#> igraph 2.0.3 2024-03-13 [2] CRAN (R 4.4.0)
#> IRanges * 2.38.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> iSEE * 2.16.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> iSEEde * 1.2.0 2024-04-30 [1] Bioconductor 3.19 (R 4.4.0)
#> iterators 1.0.14 2022-02-05 [2] CRAN (R 4.4.0)
#> jquerylib 0.1.4 2021-04-26 [2] CRAN (R 4.4.0)
#> jsonlite 1.8.8 2023-12-04 [2] CRAN (R 4.4.0)
#> KEGGREST 1.44.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> knitr 1.46 2024-04-06 [2] CRAN (R 4.4.0)
#> later 1.3.2 2023-12-06 [2] CRAN (R 4.4.0)
#> lattice 0.22-6 2024-03-20 [3] CRAN (R 4.4.0)
#> lifecycle 1.0.4 2023-11-07 [2] CRAN (R 4.4.0)
#> limma * 3.60.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> listviewer 4.0.0 2023-09-30 [2] CRAN (R 4.4.0)
#> locfit 1.5-9.9 2024-03-01 [2] CRAN (R 4.4.0)
#> lubridate 1.9.3 2023-09-27 [2] CRAN (R 4.4.0)
#> magrittr 2.0.3 2022-03-30 [2] CRAN (R 4.4.0)
#> Matrix 1.7-0 2024-03-22 [3] CRAN (R 4.4.0)
#> MatrixGenerics * 1.16.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> matrixStats * 1.3.0 2024-04-11 [2] CRAN (R 4.4.0)
#> memoise 2.0.1 2021-11-26 [2] CRAN (R 4.4.0)
#> mgcv 1.9-1 2023-12-21 [3] CRAN (R 4.4.0)
#> mime 0.12 2021-09-28 [2] CRAN (R 4.4.0)
#> miniUI 0.1.1.1 2018-05-18 [2] CRAN (R 4.4.0)
#> munsell 0.5.1 2024-04-01 [2] CRAN (R 4.4.0)
#> nlme 3.1-164 2023-11-27 [3] CRAN (R 4.4.0)
#> org.Hs.eg.db * 3.19.1 2024-04-23 [2] Bioconductor
#> pillar 1.9.0 2023-03-22 [2] CRAN (R 4.4.0)
#> pkgconfig 2.0.3 2019-09-22 [2] CRAN (R 4.4.0)
#> plyr 1.8.9 2023-10-02 [2] CRAN (R 4.4.0)
#> png 0.1-8 2022-11-29 [2] CRAN (R 4.4.0)
#> promises 1.3.0 2024-04-05 [2] CRAN (R 4.4.0)
#> R6 2.5.1 2021-08-19 [2] CRAN (R 4.4.0)
#> RColorBrewer 1.1-3 2022-04-03 [2] CRAN (R 4.4.0)
#> Rcpp 1.0.12 2024-01-09 [2] CRAN (R 4.4.0)
#> RefManageR * 1.4.0 2022-09-30 [2] CRAN (R 4.4.0)
#> rintrojs 0.3.4 2024-01-11 [2] CRAN (R 4.4.0)
#> rjson 0.2.21 2022-01-09 [2] CRAN (R 4.4.0)
#> rlang 1.1.3 2024-01-10 [2] CRAN (R 4.4.0)
#> rmarkdown 2.26 2024-03-05 [2] CRAN (R 4.4.0)
#> RSQLite 2.3.6 2024-03-31 [2] CRAN (R 4.4.0)
#> S4Arrays 1.4.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> S4Vectors * 0.42.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> sass 0.4.9 2024-03-15 [2] CRAN (R 4.4.0)
#> scales 1.3.0 2023-11-28 [2] CRAN (R 4.4.0)
#> scuttle * 1.14.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> sessioninfo * 1.2.2 2021-12-06 [2] CRAN (R 4.4.0)
#> shape 1.4.6.1 2024-02-23 [2] CRAN (R 4.4.0)
#> shiny 1.8.1.1 2024-04-02 [2] CRAN (R 4.4.0)
#> shinyAce 0.4.2 2022-05-06 [2] CRAN (R 4.4.0)
#> shinydashboard 0.7.2 2021-09-30 [2] CRAN (R 4.4.0)
#> shinyjs 2.1.0 2021-12-23 [2] CRAN (R 4.4.0)
#> shinyWidgets 0.8.6 2024-04-24 [2] CRAN (R 4.4.0)
#> SingleCellExperiment * 1.26.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> SparseArray 1.4.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> sparseMatrixStats 1.16.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> statmod 1.5.0 2023-01-06 [2] CRAN (R 4.4.0)
#> stringi 1.8.3 2023-12-11 [2] CRAN (R 4.4.0)
#> stringr 1.5.1 2023-11-14 [2] CRAN (R 4.4.0)
#> SummarizedExperiment * 1.34.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> tibble 3.2.1 2023-03-20 [2] CRAN (R 4.4.0)
#> tidyselect 1.2.1 2024-03-11 [2] CRAN (R 4.4.0)
#> timechange 0.3.0 2024-01-18 [2] CRAN (R 4.4.0)
#> UCSC.utils 1.0.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> utf8 1.2.4 2023-10-22 [2] CRAN (R 4.4.0)
#> vctrs 0.6.5 2023-12-01 [2] CRAN (R 4.4.0)
#> vipor 0.4.7 2023-12-18 [2] CRAN (R 4.4.0)
#> viridisLite 0.4.2 2023-05-02 [2] CRAN (R 4.4.0)
#> xfun 0.43 2024-03-25 [2] CRAN (R 4.4.0)
#> xml2 1.3.6 2023-12-04 [2] CRAN (R 4.4.0)
#> xtable 1.8-4 2019-04-21 [2] CRAN (R 4.4.0)
#> XVector 0.44.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#> yaml 2.3.8 2023-12-11 [2] CRAN (R 4.4.0)
#> zlibbioc 1.50.0 2024-04-30 [2] Bioconductor 3.19 (R 4.4.0)
#>
#> [1] /tmp/Rtmp9Z0T1Y/Rinst34ee0f6e3570cd
#> [2] /home/biocbuild/bbs-3.19-bioc/R/site-library
#> [3] /home/biocbuild/bbs-3.19-bioc/R/library
#>
#> ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────4 Bibliography
This vignette was generated using BiocStyle (Oleś, 2024) with knitr (Xie, 2024) and rmarkdown (Allaire, Xie, Dervieux et al., 2024) running behind the scenes.
Citations made with RefManageR (McLean, 2017).
[1] J. Allaire, Y. Xie, C. Dervieux, et al. rmarkdown: Dynamic Documents for R. R package version 2.26. 2024. URL: https://github.com/rstudio/rmarkdown.
[2] 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.
[3] A. Oleś. BiocStyle: Standard styles for vignettes and other Bioconductor documents. R package version 2.32.0. 2024. URL: https://github.com/Bioconductor/BiocStyle.
[4] R Core Team. R: A Language and Environment for Statistical Computing. R Foundation for Statistical Computing. Vienna, Austria, 2024. URL: https://www.R-project.org/.
[5] K. Rue-Albrecht. iSEEde: iSEE extension for panels related to differential expression analysis. R package version 1.2.0. 2024. URL: https://github.com/iSEE/iSEEde.
[6] 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.
[7] H. Wickham, W. Chang, R. Flight, et al. sessioninfo: R Session Information. R package version 1.2.2. 2021. URL: https://CRAN.R-project.org/package=sessioninfo.
[8] Y. Xie. knitr: A General-Purpose Package for Dynamic Report Generation in R. R package version 1.46. 2024. URL: https://yihui.org/knitr/.