1 Scenario

In this vignette, we demonstrate how one may use the package GO.db to dynamically display additional information about selected pathways in the interactive user interface.

2 Demonstration

2.1 Example data

First, we generate pathway analysis results for simulated data using fgsea.

In particular, we use the package org.Hs.eg.db to fetch real gene sets. To reduce memory footprint, we retain only the gene sets associated with 15 to 500 genes.

Then, we simulate a score for each of the gene present in any of those remaining gene sets. In practice, that score could be the log2 fold-change of the gene in a differential expression analysis (among other possibilities).

Finally, we perform an FGSEA on the simulated data.

library("org.Hs.eg.db")
library("fgsea")

# Example data ----

## Pathways
pathways <- select(org.Hs.eg.db, keys(org.Hs.eg.db, "SYMBOL"), c("GOALL"), keytype = "SYMBOL")
pathways <- subset(pathways, ONTOLOGYALL == "BP")
pathways <- unique(pathways[, c("SYMBOL", "GOALL")])
pathways <- split(pathways$SYMBOL, pathways$GOALL)
len_pathways <- lengths(pathways)
pathways <- pathways[len_pathways > 15 & len_pathways < 500]

## Features
set.seed(1)
# simulate a score for all genes found across all pathways
feature_stats <- rnorm(length(unique(unlist(pathways))))
names(feature_stats) <- unique(unlist(pathways))
# arbitrarily select a pathway to simulate enrichment
pathway_id <- "GO:0046324"
pathway_genes <- pathways[[pathway_id]]
# increase score of genes in the selected pathway to simulate enrichment
feature_stats[pathway_genes] <- feature_stats[pathway_genes] + 1

# fgsea ----

set.seed(42)
fgseaRes <- fgsea(pathways = pathways, 
                  stats    = feature_stats,
                  minSize  = 15,
                  maxSize  = 500)
head(fgseaRes[order(pval), ])
#>       pathway         pval         padj   log2err        ES      NES  size
#>        <char>        <num>        <num>     <num>     <num>    <num> <int>
#> 1: GO:0046323 2.018801e-09 9.026334e-06 0.7749390 0.5528682 2.358238    78
#> 2: GO:0046324 3.683466e-09 9.026334e-06 0.7749390 0.6107195 2.482373    60
#> 3: GO:0010827 3.316644e-07 5.418291e-04 0.6749629 0.5055047 2.156210    78
#> 4: GO:0046326 7.586889e-07 9.295836e-04 0.6594444 0.6448166 2.350896    37
#> 5: GO:0010828 1.635088e-06 1.602713e-03 0.6435518 0.5906760 2.223814    44
#> 6: GO:1904659 3.387729e-06 2.525999e-03 0.6272567 0.4322504 1.974356   118
#>     leadingEdge
#>          <list>
#> 1: AKT1, SE....
#> 2: AKT1, SE....
#> 3: AKT1, SE....
#> 4: AKT1, ER....
#> 5: AKT1, ER....
#> 6: AKT1, SE....

Then, we embed the fgsea results in a SummarizedExperiment object.

In this case, we create an empty ?SummarizedExperiment-class object, without any simulated count data nor metadata, as we will not be using any of those data in this example.

We then embed the pathway analysis results in the newly created ?SummarizedExperiment-class object.

But first, we reorder the results by increasing p-value. Although not essential, this implicitly defines the default ordering of the table in the live app.

library("SummarizedExperiment")
library("iSEEpathways")
se <- SummarizedExperiment()
fgseaRes <- fgseaRes[order(pval), ]
se <- embedPathwaysResults(fgseaRes, se, name = "fgsea", class = "fgsea", pathwayType = "GO")

2.2 Pathway information

In this example, we configure the app option PathwaysTable.select.details to define a function that, given the identifier of the GO term currently selected in a panel, displays information about that GO term.

Although not essential, this is a user-friendly and immediate way to ‘translate’ machine-friendly database identifiers into human-friendly descriptions.

library("iSEE")
library("GO.db")
library("shiny")
go_details <- function(x) {
    info <- select(GO.db, x, c("TERM", "ONTOLOGY", "DEFINITION"), "GOID")
    html <- list(p(strong(info$GOID), ":", info$TERM, paste0("(", info$ONTOLOGY, ")")))
    if (!is.na(info$DEFINITION)) {
        html <- append(html, list(p(info$DEFINITION)))
    }
    tagList(html)
}
se <- registerAppOptions(se, PathwaysTable.select.details = go_details)

2.3 Live app

Finally, we configure the app initial state and launch the live app.

app <- iSEE(se, initial = list(
  PathwaysTable(ResultName="fgsea", Selected = "GO:0046324", PanelWidth = 12L)
))

if (interactive()) {
  shiny::runApp(app)
}

3 Reproducibility

The iSEEpathways package (Rue-Albrecht and Soneson, 2024) was made possible thanks to:

  • R (R Core Team, 2024)
  • BiocStyle (Oleś, 2024)
  • knitr (Xie, 2024)
  • RefManageR (McLean, 2017)
  • rmarkdown (Allaire, Xie, Dervieux, McPherson, Luraschi, Ushey, Atkins, Wickham, Cheng, Chang, and Iannone, 2024)
  • sessioninfo (Wickham, Chang, Flight, Müller, and Hester, 2021)
  • testthat (Wickham, 2011)

This package was developed using biocthis.

Code for creating the vignette

## Create the vignette
library("rmarkdown")
system.time(render("gene-ontology.Rmd", "BiocStyle::html_document"))

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

Date the vignette was generated.

#> [1] "2024-05-01 00:20:53 EDT"

Wallclock time spent generating the vignette.

#> Time difference of 55.496 secs

R session 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)
#>  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)
#>  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)
#>  cowplot                1.1.3   2024-01-22 [2] CRAN (R 4.4.0)
#>  crayon                 1.5.2   2022-09-29 [2] CRAN (R 4.4.0)
#>  data.table             1.15.4  2024-03-30 [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)
#>  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)
#>  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)
#>  fastmatch              1.1-4   2023-08-18 [2] CRAN (R 4.4.0)
#>  fgsea                * 1.30.0  2024-04-30 [2] Bioconductor 3.19 (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)
#>  GO.db                * 3.19.1  2024-04-23 [2] Bioconductor
#>  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)
#>  iSEEpathways         * 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)
#>  listviewer             4.0.0   2023-09-30 [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)
#>  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)
#>  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/RtmpygP7gC/Rinst3512db2acdac2a
#>  [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 and C. Soneson. iSEEpathways: iSEE extension for panels related to pathway analysis. R package version 1.2.0. 2024. URL: https://github.com/iSEE/iSEEpathways.

[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/.