1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,41 @@ |
1 |
+% Generated by roxygen2: do not edit by hand |
|
2 |
+% Please edit documentation in R/utils.R |
|
3 |
+\name{get_path_names} |
|
4 |
+\alias{get_path_names} |
|
5 |
+\title{Tranlates path IDs to path names} |
|
6 |
+\usage{ |
|
7 |
+get_path_names(metaginfo, names, maxchar = NULL) |
|
8 |
+} |
|
9 |
+\arguments{ |
|
10 |
+\item{metaginfo}{Pathways object} |
|
11 |
+ |
|
12 |
+\item{names}{Character vector with the subpathway IDs to be translated} |
|
13 |
+ |
|
14 |
+\item{maxchar}{Integer, describes the number of maximum characters to |
|
15 |
+be shown. By default no filter is applied.} |
|
16 |
+} |
|
17 |
+\value{ |
|
18 |
+A character vector including the readable names of the |
|
19 |
+subpathways IDs, in the same order as provided. |
|
20 |
+} |
|
21 |
+\description{ |
|
22 |
+Translates the subpathway IDs to readable and comprensible names. |
|
23 |
+ |
|
24 |
+For effector subpathways, the names of the subpathways are encoded |
|
25 |
+as "pathway: effector_protein", where "pathway" is the pathway to |
|
26 |
+which the subpathway belongs and "effector_protein" is the name of |
|
27 |
+the last node in the subpathway. |
|
28 |
+ |
|
29 |
+For decomposed subpathways, the names of the subpathways are encoded |
|
30 |
+as "pathway: receptor_protein - effector_protein", where "pathway" is |
|
31 |
+the pathway to which the subpathway belongs, "receptor_protein" is the |
|
32 |
+name of the initial node of the subpathway and "effector_protein" is |
|
33 |
+the name of the last node in the subpathway. |
|
34 |
+} |
|
35 |
+\examples{ |
|
36 |
+data(path_vals) |
|
37 |
+pathways <- load_pathways(species = "hsa", pathways_list = c("hsa03320", |
|
38 |
+"hsa04012")) |
|
39 |
+translated_names <- get_path_names(pathways, rownames(path_vals)) |
|
40 |
+ |
|
41 |
+} |