... | ... |
@@ -28,7 +28,7 @@ parseKGMLexpandMaps(file, downloadmethod = "auto", genesOnly = TRUE, localdir,.. |
28 | 28 |
\url{https://www.genome.jp/kegg/pathway/hsa/hsa04115.html}, where p53 |
29 | 29 |
signalling pathway contains other two pathways 'apoptosis' and 'cell |
30 | 30 |
cycle'. This function parses these pathways (refered as 'maps' in KGML |
31 |
- manual), download their KGML files from KEGG FTP website, parse them |
|
31 |
+ manual), download their KGML files from KEGG REST API, parse them |
|
32 | 32 |
individually, and merge all the children pathway graphs with the |
33 | 33 |
parental pathway into one graph object. The graph is returned as the |
34 | 34 |
function value. |
... | ... |
@@ -8,7 +8,7 @@ |
8 | 8 |
in sequence to make expanding maps easier. |
9 | 9 |
} |
10 | 10 |
\usage{ |
11 |
-parseKGMLexpandMaps(file, downloadmethod = "wget", genesOnly = TRUE, localdir,...) |
|
11 |
+parseKGMLexpandMaps(file, downloadmethod = "auto", genesOnly = TRUE, localdir,...) |
|
12 | 12 |
} |
13 | 13 |
%- maybe also 'usage' for other objects documented here. |
14 | 14 |
\arguments{ |
... | ... |
@@ -25,7 +25,7 @@ parseKGMLexpandMaps(file, downloadmethod = "wget", genesOnly = TRUE, localdir,.. |
25 | 25 |
\details{ |
26 | 26 |
In KEGG pathways there're usually pathways contained('cross-linked') |
27 | 27 |
in other pathways, for example see |
28 |
- \url{http://www.genome.jp/kegg/pathway/hsa/hsa04115.html}, where p53 |
|
28 |
+ \url{https://www.genome.jp/kegg/pathway/hsa/hsa04115.html}, where p53 |
|
29 | 29 |
signalling pathway contains other two pathways 'apoptosis' and 'cell |
30 | 30 |
cycle'. This function parses these pathways (refered as 'maps' in KGML |
31 | 31 |
manual), download their KGML files from KEGG FTP website, parse them |
... | ... |
@@ -42,6 +42,6 @@ parseKGMLexpandMaps(file, downloadmethod = "wget", genesOnly = TRUE, localdir,.. |
42 | 42 |
\value{ |
43 | 43 |
A directed graph object |
44 | 44 |
} |
45 |
-\references{KGML Document manual \url{http://www.genome.jp/kegg/docs/xml/}} |
|
45 |
+\references{KGML Document manual \url{https://www.genome.jp/kegg/docs/xml/}} |
|
46 | 46 |
\author{ Jitao David Zhang \url{[email protected]}} |
47 | 47 |
\seealso{ for most users it is enough to use \code{\link{parseKGML2Graph}} } |
git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/KEGGgraph@57194 bc3139a8-67e5-0310-9ffc-ced21a209358
... | ... |
@@ -43,5 +43,5 @@ parseKGMLexpandMaps(file, downloadmethod = "wget", genesOnly = TRUE, localdir,.. |
43 | 43 |
A directed graph object |
44 | 44 |
} |
45 | 45 |
\references{KGML Document manual \url{http://www.genome.jp/kegg/docs/xml/}} |
46 |
-\author{ Jitao David Zhang \url{[email protected]}} |
|
46 |
+\author{ Jitao David Zhang \url{[email protected]}} |
|
47 | 47 |
\seealso{ for most users it is enough to use \code{\link{parseKGML2Graph}} } |
git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/KEGGgraph@35854 bc3139a8-67e5-0310-9ffc-ced21a209358
1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,47 @@ |
1 |
+\name{parseKGMLexpandMaps} |
|
2 |
+\alias{parseKGMLexpandMaps} |
|
3 |
+%- Also NEED an '\alias' for EACH other topic documented here. |
|
4 |
+\title{ A convenient function to parse KGML and expand its containing |
|
5 |
+ maps into one graph object } |
|
6 |
+\description{ |
|
7 |
+ The function does several tasks implemented in the KEGGgraph package |
|
8 |
+ in sequence to make expanding maps easier. |
|
9 |
+} |
|
10 |
+\usage{ |
|
11 |
+parseKGMLexpandMaps(file, downloadmethod = "wget", genesOnly = TRUE, localdir,...) |
|
12 |
+} |
|
13 |
+%- maybe also 'usage' for other objects documented here. |
|
14 |
+\arguments{ |
|
15 |
+ \item{file}{ A KGML file } |
|
16 |
+ \item{downloadmethod}{ passed to \code{\link{download.file}} function |
|
17 |
+ as 'method', see its documentation for more details } |
|
18 |
+ \item{genesOnly}{ logical, should only the genes nodes remain in the |
|
19 |
+ returned graph object? } |
|
20 |
+ \item{localdir}{ character string, if specified, the function tries to |
|
21 |
+ read files with the same base name from a local directory, useful |
|
22 |
+ when there are file copies on the client.} |
|
23 |
+ \item{\dots}{ Other parameters passed to \code{\link{download.file}} } |
|
24 |
+} |
|
25 |
+\details{ |
|
26 |
+ In KEGG pathways there're usually pathways contained('cross-linked') |
|
27 |
+ in other pathways, for example see |
|
28 |
+ \url{http://www.genome.jp/kegg/pathway/hsa/hsa04115.html}, where p53 |
|
29 |
+ signalling pathway contains other two pathways 'apoptosis' and 'cell |
|
30 |
+ cycle'. This function parses these pathways (refered as 'maps' in KGML |
|
31 |
+ manual), download their KGML files from KEGG FTP website, parse them |
|
32 |
+ individually, and merge all the children pathway graphs with the |
|
33 |
+ parental pathway into one graph object. The graph is returned as the |
|
34 |
+ function value. |
|
35 |
+ |
|
36 |
+ Since different graphs does not have unique node identifiers unless |
|
37 |
+ the genes are expanded, so by using this function user has to expand |
|
38 |
+ the genes. Another disadvantage is that so far due to the |
|
39 |
+ implementation, the KEGGnodeData and KEGGedgeData is lost during the |
|
40 |
+ merging. This however will probably be changed in the future version. |
|
41 |
+} |
|
42 |
+\value{ |
|
43 |
+ A directed graph object |
|
44 |
+} |
|
45 |
+\references{KGML Document manual \url{http://www.genome.jp/kegg/docs/xml/}} |
|
46 |
+\author{ Jitao David Zhang \url{[email protected]}} |
|
47 |
+\seealso{ for most users it is enough to use \code{\link{parseKGML2Graph}} } |