synonyms_to_hgnc: Map gene synonyms to HGNC symbols

View source: R/gene_infos.R

synonyms_to_hgncR Documentation

Map gene synonyms to HGNC symbols

Description

Maps gene synonyms to their official HGNC symbol.

Usage

synonyms_to_hgnc(input, verbose = FALSE, warn = TRUE, ...)

Arguments

input

Character vector of possible gene synonyms.

verbose

Logical. If TRUE, informative message are printed in the console about which elements of input could be matched to which genes and which could not be mapped.

warn

Logical. If TRUE, a warning is printed if elements of argument input are neither identified as a gene symbol nor as matching synonym.

Details

Elements of input that are, in fact, synonyms are replaced by their official HGNC symbol. Elements that are already HGNC symbols stay as they are. Elements that are neither are silently dropped.

Value

Character vector.

Examples


# give feedback and warn
synonyms_to_hgnc(input = c("GFAP", "M33", "XXX"), verbose = T, warn = T)

# give only feedback and drop silently
synonyms_to_hgnc(input = c("GFAP", "M33", "XXX"), verbose = T, warn = F)



kueckelj/confuns documentation built on July 4, 2024, 4:53 p.m.