buildDatabase: Build a local database containing the required information...

Description Usage Arguments Details Value Note Author(s) References See Also Examples

View source: R/buildDatabase.R

Description

buildDatabase uses the internet connection to access KEGG database and locally install the required data to use papi offline.

Usage

1
buildDatabase(save = TRUE, folder, saveAs)

Arguments

save

when save = TRUE, the new local database is saved in the folder defined by folder in addition to the folder R.home("library/PAPi/databases/").

folder

when save = TRUE and folder is missing, a pop up dialog box will be presented to the user. The user can then select the directory to which the results will be saved. Alternatively, folder can take a character string naming the path to the folder where the new database must be saved.

saveAs

A character string defining the name of the new local database.

Details

papi is an algorithm to relate metabolite abundances to the activity of metabolic pathways. For this, PAPi uses the information available in KEGG database. However, applying PAPi online may be considerably time consuming depending on the internet connection available. In addition, KEGG database is constantly updated, which means that results produced by PAPi today may be different from results produced one month earlier. buildDatabase allows users to build local databases containing the required data from KEGG database. It allows to reproduce results at anytime and considerably faster analysis.

Value

buildDatabase stores the local database in R.home("library/PAPi/databases/").

Note

Raphael Aggio (raphael.aggio@gmail.com)

Author(s)

Raphael Aggio

References

Aggio, R.B.M; Ruggiero, K. and Villas-Boas, S.G. (2010) - Pathway Activity Profiling (PAPi): from metabolite profile to metabolic pathway activity. Bioinformatics.

See Also

addKeggCodes, papi, papiHtest and papiLine.

Examples

1
#buildDatabase(save = FALSE, saveAs = "MyNewDatabase")

Example output

Loading required package: svDialogs
Loading required package: svGUI
Loading required package: KEGGREST

PAPi documentation built on Oct. 31, 2019, 3:19 a.m.