Skip to contents

Load a built in database

Source: R/dbmanager.R
load_db.Rd

Load a built in database

Usage

load_db(key, param = list())

Arguments

key

Character: the key of the database to load. For a list of available keys see omnipath_show_db.

param

List: override the defaults or pass further parameters to the database loader function. See the loader functions and their default parameters in omnipath_show_db.

Value

Returns NULL.

Details

This function loads a database which is stored within the package namespace until its expiry. The loaded database is accessible by get_db and the loading process is typically initiated by get_db, not by the users directly.

See also

omnipath_show_db, get_db

Examples

load_db('go_slim')
omnipath_show_db()
#> # A tibble: 20 × 10
#>    name     last_used           lifet…¹ package loader loader_param latest_param
#>    <chr>    <dttm>                <dbl> <chr>   <chr>  <list>       <list>      
#>  1 Gene On… 2023-03-22 18:53:41     300 Omnipa… go_on… <named list> <named list>
#>  2 Gene On… NA                      300 Omnipa… go_on… <named list> <lgl [1]>   
#>  3 Gene On… NA                      300 Omnipa… go_on… <named list> <lgl [1]>   
#>  4 Gene On… NA                      300 Omnipa… go_on… <named list> <lgl [1]>   
#>  5 Gene On… 2023-03-22 18:57:47     300 Omnipa… go_on… <named list> <named list>
#>  6 Gene On… NA                      300 Omnipa… go_on… <named list> <lgl [1]>   
#>  7 Gene On… NA                      300 Omnipa… go_on… <named list> <lgl [1]>   
#>  8 Gene On… NA                      300 Omnipa… go_on… <named list> <lgl [1]>   
#>  9 Gene On… NA                      300 Omnipa… go_on… <named list> <lgl [1]>   
#> 10 Gene On… NA                      300 Omnipa… go_on… <named list> <lgl [1]>   
#> 11 Gene On… NA                      300 Omnipa… go_on… <named list> <lgl [1]>   
#> 12 Gene On… NA                      300 Omnipa… go_on… <named list> <lgl [1]>   
#> 13 Gene On… NA                      300 Omnipa… go_on… <named list> <lgl [1]>   
#> 14 Gene On… NA                      300 Omnipa… go_on… <named list> <lgl [1]>   
#> 15 GO anno… NA                      300 Omnipa… go_an… <named list> <lgl [1]>   
#> 16 UniProt… 2023-03-22 18:57:45     300 Omnipa… unipr… <named list> <named list>
#> 17 Ensembl… 2023-03-22 18:57:46   10800 Omnipa… taxon… <NULL>       <NULL>      
#> 18 All Swi… 2023-03-22 18:56:34   10800 Omnipa… all_u… <named list> <named list>
#> 19 All TrE… 2023-03-22 18:56:57   10800 Omnipa… all_u… <named list> <named list>
#> 20 OmniPat… NA                      300 Omnipa… build… <named list> <lgl [1]>   
#> # … with 3 more variables: loaded <lgl>, db <list>, key <chr>, and abbreviated
#> #   variable name ¹​lifetime