Diff of /man/getGeneMapping.Rd [000000] .. [72a7c3]

Switch to unified view

a b/man/getGeneMapping.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/feature_processing.R
3
\name{getGeneMapping}
4
\alias{getGeneMapping}
5
\title{Mapping between pathway encoded genes/proteins and different ID formats.}
6
\usage{
7
getGeneMapping(features, keytype, org = "hsapiens", returntype = "SYMBOL")
8
}
9
\arguments{
10
\item{features}{List of identifiers to be mapped.}
11
12
\item{keytype}{String specifying the ID type, e.g., "ENTREZID" or "UNIPROT".}
13
14
\item{org}{String that defines the organism. Default: hsapiens
15
Options: see \code{\link[multiGSEA]{getOrganisms}}}
16
17
\item{returntype}{String that specifies the returning ID type. Default:
18
SYMBOL, Options: SYMBOL, ENTREZID, UNIPROT, ENSEMBL, REFSEQ}
19
}
20
\value{
21
List containing mapped gene/protein IDs.
22
}
23
\description{
24
Function to retrieve the gene/protein identifier mapping. Ongoing from
25
genes/proteins retrieved from pathway definitions, which often include two or
26
more ID formats or a format that is not present in your omics measurement,
27
this function maps those IDs to a given format. Depending on the organism,
28
additional packages have to be installed.
29
}
30
\examples{
31
features <- graphite::nodes(graphite::pathways("hsapiens", "kegg")[[1]])
32
features <- gsub("ENTREZID:", "", features)
33
keytype <- "ENTREZID"
34
getGeneMapping(features, keytype)
35
36
getGeneMapping(features, keytype, returntype = "UNIPROT")
37
\donttest{
38
features <- graphite::nodes(graphite::pathways("rnorvegicus", "reactome")[[1]])
39
features <- gsub("UNIPROT:", "", features)
40
getGeneMapping(features, keytype = "UNIPROT", org = "rnorvegicus")
41
42
getGeneMapping(features,
43
  keytype = "UNIPROT",
44
  org = "rnorvegicus",
45
  returntype = "ENSEMBL"
46
)
47
}
48
49
}