getSynonyms: getSynonyms

Description Usage Arguments Value

View source: R/TCGAGeneReport.R

Description

Given a purported gene symbol, looks up any HGNC gene symbols whose synonyms match the purported string, in a case insensitive manner.

Usage

1
getSynonyms(theId, theZipFile="/rsrch1/bcb/batcheffects/GENE_REPORT/GeneSurvey.zip", theVerboseFlag = FALSE)

Arguments

theId

The purported gene symbol, a string

theZipFile

Default: For DQS Servers. If you are on a server where the GENE_REPORT directory is on a different path, you can pass in a value to override the default of "/rsrch1/bcb/batcheffects/GENE_REPORT/GeneSurvey.zip". NOTE: this is a subdirectory of GENE_REPORT.

theVerboseFlag

Default: FALSE. TRUE means write all output, which can be very verbose.

Value

A list of strings which are gene symbols which have synonyms matching (case insensitive) the one provided.


GeneSurvey/TCGAGeneReport documentation built on May 6, 2019, 6:27 p.m.