The database manager is an API within OmnipathR which is able to load various datasets, keep track of their usage and remove them after an expiry period. Currently it supports a few Gene Ontology and UniProt datasets, but easily can be extended to cover all datasets in the package.
OmnipathR 3.12.4
1 Institute for Computational Biomedicine, Heidelberg University
To see a full list of datasets call the omnipath_show_db function:
library(OmnipathR)
omnipath_show_db()## # A tibble: 23 × 10
## name last_used lifetime package loader loader_param latest_param loaded db key
## <chr> <dttm> <dbl> <chr> <chr> <list> <lgl> <lgl> <lis> <chr>
## 1 Gene Ontology (ba… NA 300 OmnipathR go_ontology_d… <named list> NA FALSE <lgl> go_b…
## 2 Gene Ontology (fu… NA 300 OmnipathR go_ontology_d… <named list> NA FALSE <lgl> go_f…
## 3 Gene Ontology (AG… NA 300 OmnipathR go_ontology_d… <named list> NA FALSE <lgl> go_a…
## 4 Gene Ontology (As… NA 300 OmnipathR go_ontology_d… <named list> NA FALSE <lgl> go_a…
## 5 Gene Ontology (ge… NA 300 OmnipathR go_ontology_d… <named list> NA FALSE <lgl> go_s…
## 6 Gene Ontology (Ca… NA 300 OmnipathR go_ontology_d… <named list> NA FALSE <lgl> go_c…
## 7 Gene Ontology (Dr… NA 300 OmnipathR go_ontology_d… <named list> NA FALSE <lgl> go_d…
## 8 Gene Ontology (Ch… NA 300 OmnipathR go_ontology_d… <named list> NA FALSE <lgl> go_c…
## 9 Gene Ontology (me… NA 300 OmnipathR go_ontology_d… <named list> NA FALSE <lgl> go_m…
## 10 Gene Ontology (pl… NA 300 OmnipathR go_ontology_d… <named list> NA FALSE <lgl> go_p…
## # ℹ 13 more rowsIt returns a tibble where each dataset has a human readable name and a key which can be used to refer to it. We can also check here if the dataset is currently loaded, the time it’s been last used, the loader function and its arguments.
Datasets can be accessed by the get_db function. Ideally you should call
this function every time you use the dataset. The first time it will be
loaded, the subsequent times the already loaded dataset will be returned.
This way each access is registered and extends the expiry time. Let’s load
the human UniProt-GeneSymbol table. Above we see its key is up_gs.
up_gs <- get_db('up_gs')
up_gs## NULLThis dataset is a two columns data frame of SwissProt IDs and Gene Symbols.
Looking again at the datasets, we find that this dataset is loaded now and
the last_used timestamp is set to the time we called get_db:
omnipath_show_db()## # A tibble: 23 × 10
## name last_used lifetime package loader loader_param latest_param loaded db key
## <chr> <dttm> <dbl> <chr> <chr> <list> <list> <lgl> <lis> <chr>
## 1 Gene Ontology (ba… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_b…
## 2 Gene Ontology (fu… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_f…
## 3 Gene Ontology (AG… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_a…
## 4 Gene Ontology (As… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_a…
## 5 Gene Ontology (ge… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_s…
## 6 Gene Ontology (Ca… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_c…
## 7 Gene Ontology (Dr… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_d…
## 8 Gene Ontology (Ch… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_c…
## 9 Gene Ontology (me… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_m…
## 10 Gene Ontology (pl… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_p…
## # ℹ 13 more rowsThe above table contains also a reference to the dataset, and the arguments passed to the loader function:
d <- omnipath_show_db()
d %>% dplyr::pull(db) %>% magrittr::extract2(16)## NULLd %>% dplyr::pull(latest_param) %>% magrittr::extract2(16)## $to
## [1] "genesymbol"
##
## $organism
## [1] 9606If we call get_db again, the timestamp is updated, resetting the expiry
counter:
up_gs <- get_db('up_gs')
omnipath_show_db()## # A tibble: 23 × 10
## name last_used lifetime package loader loader_param latest_param loaded db key
## <chr> <dttm> <dbl> <chr> <chr> <list> <list> <lgl> <lis> <chr>
## 1 Gene Ontology (ba… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_b…
## 2 Gene Ontology (fu… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_f…
## 3 Gene Ontology (AG… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_a…
## 4 Gene Ontology (As… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_a…
## 5 Gene Ontology (ge… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_s…
## 6 Gene Ontology (Ca… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_c…
## 7 Gene Ontology (Dr… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_d…
## 8 Gene Ontology (Ch… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_c…
## 9 Gene Ontology (me… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_m…
## 10 Gene Ontology (pl… NA 300 OmnipathR go_ontology_d… <named list> <lgl [1]> FALSE <lgl> go_p…
## # ℹ 13 more rowsThe loaded datasets live in an environment which belong to the OmnipathR
package. Normally users don’t need to access this environment. As we see
below, omnipath_show_db presents us all information availble by directly
looking at the environment:
OmnipathR:::omnipath.env$db$up_gs## $name
## [1] "UniProt-GeneSymbol table"
##
## $last_used
## [1] "2024-10-02 18:52:27 EDT"
##
## $lifetime
## [1] 300
##
## $package
## [1] "OmnipathR"
##
## $loader
## [1] "uniprot_full_id_mapping_table"
##
## $loader_param
## $loader_param$to
## [1] "genesymbol"
##
## $loader_param$organism
## [1] 9606
##
##
## $latest_param
## $latest_param$to
## [1] "genesymbol"
##
## $latest_param$organism
## [1] 9606
##
##
## $loaded
## [1] TRUEThe default expiry of datasets is given by the option omnipath.db_lifetime.
By calling omnipath_save_config this option is saved to the default config
file and will be valid in all subsequent sessions. Otherwise it’s valid only
in the current session.
options(omnipath.db_lifetime = 600)
omnipath_save_config()The built-in dataset definitions are in a JSON file shipped with the package. Easiest way to see it is by the git web interface.
Currently no API available for this, but it would be super easy to implement. It would be matter of providing a JSON similar to the above, or calling a function. Please open an issue if you are interested in this feature.
sessionInfo()## R version 4.4.1 (2024-06-14)
## Platform: x86_64-pc-linux-gnu
## Running under: Ubuntu 22.04.5 LTS
##
## Matrix products: default
## BLAS: /home/biocbuild/bbs-3.19-bioc/R/lib/libRblas.so
## LAPACK: /usr/lib/x86_64-linux-gnu/lapack/liblapack.so.3.10.0
##
## locale:
## [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C LC_TIME=en_GB
## [4] LC_COLLATE=C LC_MONETARY=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8
## [7] LC_PAPER=en_US.UTF-8 LC_NAME=C LC_ADDRESS=C
## [10] LC_TELEPHONE=C LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
##
## time zone: America/New_York
## tzcode source: system (glibc)
##
## attached base packages:
## [1] stats graphics grDevices utils datasets methods base
##
## other attached packages:
## [1] OmnipathR_3.12.4 BiocStyle_2.32.1
##
## loaded via a namespace (and not attached):
## [1] tidyr_1.3.1 rappdirs_0.3.3 sass_0.4.9 utf8_1.2.4 generics_0.1.3
## [6] xml2_1.3.6 stringi_1.8.4 hms_1.1.3 digest_0.6.37 magrittr_2.0.3
## [11] evaluate_1.0.0 timechange_0.3.0 bookdown_0.40 fastmap_1.2.0 cellranger_1.1.0
## [16] jsonlite_1.8.9 processx_3.8.4 progress_1.2.3 backports_1.5.0 chromote_0.3.1
## [21] ps_1.8.0 promises_1.3.0 BiocManager_1.30.25 httr_1.4.7 rvest_1.0.4
## [26] selectr_0.4-2 purrr_1.0.2 fansi_1.0.6 jquerylib_0.1.4 cli_3.6.3
## [31] rlang_1.1.4 crayon_1.5.3 bit64_4.5.2 withr_3.0.1 cachem_1.1.0
## [36] yaml_2.3.10 parallel_4.4.1 tools_4.4.1 tzdb_0.4.0 checkmate_2.3.2
## [41] dplyr_1.1.4 curl_5.2.3 vctrs_0.6.5 logger_0.3.0 R6_2.5.1
## [46] lifecycle_1.0.4 lubridate_1.9.3 stringr_1.5.1 bit_4.5.0 vroom_1.6.5
## [51] pkgconfig_2.0.3 pillar_1.9.0 bslib_0.8.0 later_1.3.2 glue_1.8.0
## [56] Rcpp_1.0.13 xfun_0.47 tibble_3.2.1 tidyselect_1.2.1 knitr_1.48
## [61] websocket_1.4.2 htmltools_0.5.8.1 igraph_2.0.3 rmarkdown_2.28 readr_2.1.5
## [66] compiler_4.4.1 prettyunits_1.2.0 readxl_1.4.3