proc_gmt: Helper to save 'gmt'

proc_gmtR Documentation

Helper to save 'gmt'

Description

Helper to save 'gmt'

Usage

proc_gmt(species, abbr_species, ortho_mart, fn_gmt, db_path, filename)

Arguments

species

Character string; the name of a species for the conveninent preparation of MSig data bases. The species available for the convenience feature is in one of c("human", "mouse", "rat") with "human" being the default. The argument is not required for other species; instead, users will provide values under arguments ortho_mart for the lookup of orthologs to human.

abbr_species

Two-letter character string; the abbreviated name of species used with org.Xx.eg.db. The value of abbr_species will be determined automatically if the species is in one of c("human", "mouse", "rat"). Otherwise, for example, users need to provide abbr_species = Ce for fetching the org.Ce.eg.db package in the name space of proteoQ.

For analysis against gene ontology and Molecular Signatures, the argument is further applied to differentiate the same biological terms under different species; e.g., GO~0072686 mitotic spindle becomes hs_GO~0072686 mitotic spindle for human and mm_GO~0072686 mitotic spindle for mouse.

ortho_mart

Character string; a dataset name from useMart and/or listDatasets for the lookup of orthologs to human genes. For species in c("human", "mouse", "rat"), the value will be determined automatically unless otherwise specified.

fn_gmt

filename of downloaded gmt results.

db_path

Character string; the local path for database(s). The default is "~/proteoQ/dbs/msig".

filename

Character string; An output file name. At the NULL default, the name will be determined automatically at a given species; i.e., msig_hs.rds for human data. The file is saved as a .rds object for uses with prnGSPA.


qzhang503/proteoQ documentation built on Dec. 14, 2024, 12:27 p.m.