get_db: Access a built in database

In saezlab/OmnipathR: OmniPath web service client and more

Access a built in database

Description

Databases are resources which might be costly to load but can be used many times by functions which usually automatically load and retrieve them from the database manager. Each database has a lifetime and will be unloaded automatically upon expiry.

Usage

get_db(key, param = NULL, reload = FALSE, ...)

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. If the database is already loaded with different parameters it will be reloaded with the new parameters only if the reload option is TRUE.
reload	Reload the database if param passed here is different from the parameters used the last time the database was loaded. If different functions with different parameters access the database repeatedly and request reload the frequent reloads might cost substantial time and resource use.
...	Arguments for the loader function of the database. These override the default arguments.

Value

An object with the database contents. The exact format depends on the database, most often it is a data frame or a list.

See Also

omnipath_show_db.

Examples

organisms <- get_db('organisms')

saezlab/OmnipathR documentation built on Oct. 16, 2024, 11:49 a.m.