upload_GMT_file: Upload custom annotations for functional enrichment analysis...

View source: R/gprofiler2.R

upload_GMT_fileR Documentation

Upload custom annotations for functional enrichment analysis in g:GOSt.

Description

Upload your own annotation data using files in the Gene Matrix Transposed file format (GMT) for functional enrichment analysis in g:GOSt. The accepted file is either a single annotations file (with the extension .gmt) or a compressed directory of multiple annotation GMT files (with the extension .zip). The GMT format is a tab-separated list of gene annotation sets where every line represents a separate gene set/functional term. The first column defines the function ID, second defines a short name/description of the function and the following columns are the list of genes related to the specific function in that row.

Usage

upload_GMT_file(gmtfile)

Arguments

gmtfile

the filepath of the GMT file to be uploaded. The file extension should be .gmt or .zip in case of multiple GMT files. If the filepath does not contain an absolute path, the filename is relative to the current working directory.

Details

The uploaded filename is used to define 'source' name in the g:GOSt results.

Value

A string that denotes the ID of the uploaded custom annotations in the g:Profiler database. After the GMT file upload this unique ID can be used as a value for the argument 'organism' in the gost() function to perform functional enrichment analysis based on these custom data.

No need to repeatedly upload the same custom GMT file(s) every time you want to do the enrichment analysis. The custom ID can also be used in the web tool as a token under the Custom GMT options.

Author(s)

Liis Kolberg <liis.kolberg@ut.ee>

Examples

## Not run: custom_id <- upload_GMT_file("path/to/file.gmt")

gprofiler2 documentation built on July 9, 2023, 6:06 p.m.