RaMP: Connection to a RaMP database

In ncats/RaMP-DB: RaMP (Relational Database of Metabolomic Pathways)

Connection to a RaMP database

Description

Connections to a *RaMP* database can be established and managed with the 'RaMP' function. The returned 'RaMP' object provides the reference to the database and it can be passed to the various functions to query that specific database. RaMP databases are provided as self-contained SQLite databases that are automatically downloaded and locally cached with the 'RaMP' function. The caching mechanism prevents repeated downloads of the same database version.

- 'RaMP': eventually download and connect to a RaMP database. Parameter 'version' allows to specify the RaMP release version to which a connection should be established. If the specified version is not available locally, it will be downloaded and cached. Use 'listRaMPVersions()' to list available local or remote databases. Alternatively, the connection to a RaMP database can be directly provided through parameter 'dbcon'.

- 'listRaMPVersions': list available local or remote RaMP database releases.

Usage

## S4 method for signature 'RaMP'
show(object)

RaMP(version = character())

listRaMPVersions(local = FALSE)

Arguments

version	'character(1)' specifying the RaMP version to load. By default ('version = character()'), the most recent release will be used.
local	'logical(1)' for 'listRaMPVersion': whether remote ('local = FALSE', default) or locally ('local = TRUE') available RaMP versions should be listed.

ncats/RaMP-DB documentation built on June 1, 2024, 9:34 p.m.