Browse code

update documentation for newer roxygen version

From: vandersm <vandersm@mail.uc.edu>

git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/KEGGlincs@127888 bc3139a8-67e5-0310-9ffc-ced21a209358

Shana White authored on 30/03/2017 20:47:47
Showing 20 changed files

... ...
@@ -11,7 +11,7 @@ Description: See what is going on 'under the hood' of KEGG pathways by
11 11
         obtained from KGML files.
12 12
 License: GPL-3
13 13
 LazyData: true
14
-RoxygenNote: 5.0.1
14
+RoxygenNote: 6.0.1
15 15
 Depends: R (>= 3.3), KOdata, hgu133a.db, org.Hs.eg.db (>= 3.3.0)
16 16
 SystemRequirements: Cytoscape (>= 3.3.0), Java (>= 8)
17 17
 Suggests: BiocInstaller (>= 1.20.3), knitr, graph
... ...
@@ -4,7 +4,7 @@
4 4
 #' @param pathwayid A KEGG pathway ID of the form "hsa12345" 
5 5
 #' (only human pathways currently)
6 6
 #' @return A data.frame object with either disease or drug information
7
-#' @importFrom XML readHTMLTable
7
+#' @import XML
8 8
 #' @export
9 9
 #' @examples
10 10
 #' RA_drug_table <- get_drug_table("hsa05323")
... ...
@@ -69,4 +69,3 @@ p53_edge_info <- KEGG_lincs("hsa04115", graph_title = "p53"
69 69
                              convert_KEGG_IDs = FALSE, get_data = TRUE)
70 70
                              }
71 71
 }
72
-
... ...
@@ -8,4 +8,3 @@
8 8
 \description{
9 9
 KEGGlincs: an R package designed to explore the edges in KEGG pathways
10 10
 }
11
-
... ...
@@ -28,4 +28,3 @@ end_res_edges <- expand_KEGG_edges(end_res_KGML, end_res_KEGG_mappings)
28 28
 end_res_drugs <- get_drug_table("hsa01522")
29 29
 edges_plus_kdrug <- add_KEGG_drugs(end_res_edges, end_res_KEGG_mappings, end_res_drugs)
30 30
 }
31
-
... ...
@@ -44,4 +44,3 @@ p53_edges_HA1E_MAPPED <- add_edge_data(p53_edges, p53_KEGG_mappings,
44 44
                                         p53_HA1E_data, c(3, 10,12), 
45 45
                                         only_mapped = TRUE)
46 46
 }
47
-
... ...
@@ -41,5 +41,28 @@ edges <- edge_mapping_info(p53_edges)
41 41
 
42 42
 p53_graph_object <- get_graph_object(nodes, edges)
43 43
                                       
44
-}
44
+\dontrun{
45
+cyto_vis(p53_graph_object, "Default p53 Graph [no data added]")
46
+
47
+#Workflow to visualize graph with data-dependent attributes:
48
+
49
+p53_KGML <- get_KGML("hsa04115")
50
+p53_KEGG_mappings <- expand_KEGG_mappings(p53_KGML)
51
+nodes <- node_mapping_info(p53_KEGG_mappings)
45 52
 
53
+p53_edges <- expand_KEGG_edges(p53_KGML, p53_KEGG_mappings)
54
+
55
+p53_HA1E_data <- overlap_info(p53_KGML, p53_KEGG_mappings, "HA1E", 
56
+                               data_type = "100_bing")
57
+p53_edges_plus_data <- add_edge_data(p53_edges, p53_KEGG_mappings, 
58
+                                      p53_HA1E_data, c(3, 10,12),
59
+                                      only_mapped = TRUE)
60
+
61
+edges <- edge_mapping_info(p53_edges_plus_data, data_added = TRUE)
62
+                                            
63
+p53_plus_data_graph_object <- get_graph_object(nodes, edges)
64
+                                                
65
+cyto_vis(p53_plus_data_graph_object, "p53 Graph: Mapped Edges + HA1E Data",
66
+         edge_width_attribute = "UP")
67
+         }
68
+}
... ...
@@ -48,4 +48,3 @@ p53_edge_mapping_HA1E <- edge_mapping_info(p53_edges_HA1E_data_MAPPED,
48 48
                                                       data_added = TRUE)
49 49
                                                       
50 50
 }
51
-
... ...
@@ -28,4 +28,3 @@ p53_KGML <- get_KGML("hsa04115")
28 28
 p53_KEGG_mappings <- expand_KEGG_mappings(p53_KGML, FALSE)
29 29
 p53_edges <- expand_KEGG_edges(p53_KGML, p53_KEGG_mappings)
30 30
 }
31
-
... ...
@@ -31,4 +31,3 @@ mappings based on multi-valued name attribute
31 31
 p53_KGML <- get_KGML("hsa04115")
32 32
 p53_KEGG_mappings <-  expand_KEGG_mappings(p53_KGML, FALSE)
33 33
 }
34
-
... ...
@@ -38,4 +38,3 @@ Intended for use within \code{\link{cyto_vis}}
38 38
 style.name = "myKEGGstyle"
39 39
 mappings <- generate_mappings(style.name, FALSE)
40 40
 }
41
-
... ...
@@ -30,4 +30,3 @@ ribosome_KGML <- get_KGML("hsa03020")
30 30
 ribosome_KGML <- get_KGML("hsa03020", get_if_no_edges = TRUE) 
31 31
 
32 32
 }
33
-
... ...
@@ -1,8 +1,8 @@
1 1
 % Generated by roxygen2: do not edit by hand
2 2
 % Please edit documentation in R/get_dd_tables.R
3 3
 \name{get_drug_table}
4
-\alias{get_disease_table}
5 4
 \alias{get_drug_table}
5
+\alias{get_disease_table}
6 6
 \title{Import disease/drug tables from KEGG}
7 7
 \usage{
8 8
 get_drug_table(pathwayid)
... ...
@@ -23,4 +23,3 @@ selected pathway
23 23
 \examples{
24 24
 RA_drug_table <- get_drug_table("hsa05323")
25 25
 }
26
-
... ...
@@ -33,4 +33,3 @@ ex.data <- data.frame("UP" = c(70,6), "DOWN" = c(8,20),
33 33
 
34 34
 overlaps <- get_fisher_info(ex.data, method = "BH")
35 35
 }
36
-
... ...
@@ -42,4 +42,3 @@ layered_nodes_graph_object <- get_graph_object(p53_node_mapping_info,
42 42
                                                p53_edge_mapping_info, 
43 43
                                                layered_nodes = TRUE)
44 44
 }
45
-
... ...
@@ -24,4 +24,3 @@ p53_KEGG_mappings <- expand_KEGG_mappings(p53_KGML, FALSE)
24 24
 
25 25
 p53_node_mapping_info <- node_mapping_info(p53_KEGG_mappings)
26 26
 }
27
-
... ...
@@ -56,4 +56,3 @@ p53_HA1E_data <- overlap_info(p53_KGML, p53_KEGG_mappings,
56 56
                                "HA1E", data_type = "100_bing", 
57 57
                                only_mapped = FALSE)
58 58
 }
59
-
... ...
@@ -31,4 +31,3 @@ p53_KEGG_mappings <- expand_KEGG_mappings(p53_KGML)
31 31
 
32 32
 path_genes_by_cell_type(p53_KEGG_mappings)
33 33
 }
34
-
... ...
@@ -26,4 +26,3 @@ p53_KGML <- get_KGML("hsa04115")
26 26
 p53_KEGG_mappings <-  expand_KEGG_mappings(p53_KGML)
27 27
 MCF7_p53_mappings <- refine_mappings(p53_KEGG_mappings, "MCF7")
28 28
 }
29
-
... ...
@@ -1,8 +1,8 @@
1 1
 % Generated by roxygen2: do not edit by hand
2 2
 % Please edit documentation in R/from_cyREST.R
3 3
 \name{toCytoscape}
4
-\alias{mapAttributes}
5 4
 \alias{toCytoscape}
5
+\alias{mapAttributes}
6 6
 \title{cyREST utility functions}
7 7
 \usage{
8 8
 toCytoscape(igraphobj)
... ...
@@ -26,4 +26,3 @@ A subset of the R utility functions available from/defined
26 26
  by cyREST.  The function mapAttributes is called from within toCytoscape 
27 27
  which, in turn, is called from within cyto_vis.
28 28
 }
29
-