Browse code

Documenting the sample output from g:Profiler

Federico Marini authored on 26/05/2020 08:34:52
Showing 1 changed files

... ...
@@ -30,6 +30,8 @@ NULL
30 30
 #'
31 31
 #' Details on how this object has been created are included in the `create_gt_data.R`
32 32
 #' script, included in the `scripts` folder of the `GeneTonic` package.
33
+#' 
34
+#' @family pathway-analysis-results
33 35
 #'
34 36
 #' @references Alasoo, et al. "Shared genetic effects on chromatin and gene
35 37
 #' expression indicate a role for enhancer priming in immune response",
... ...
@@ -52,6 +54,8 @@ NULL
52 54
 #'
53 55
 #' Details on how this object has been created are included in the `create_gt_data.R`
54 56
 #' script, included in the `scripts` folder of the `GeneTonic` package.
57
+#' 
58
+#' @family pathway-analysis-results
55 59
 #'
56 60
 #' @references Alasoo, et al. "Shared genetic effects on chromatin and gene
57 61
 #' expression indicate a role for enhancer priming in immune response",
... ...
@@ -63,6 +67,26 @@ NULL
63 67
 
64 68
 
65 69
 
66
-
67
-
70
+#' A sample output from g:Profiler
71
+#'
72
+#' A sample output object as created from a call to g:Profiler, with the interface
73
+#' provided by `gprofiler2` - using the `gost()` function
74
+#'
75
+#' @details This object has been created on the data from the `macrophage` package
76
+#' by analyzing downstream the differentially expressed genes
77
+#' when comparing IFNg treated samples vs naive samples, accounting
78
+#' for the different cell lines included.
79
+#'
80
+#' Details on how this object has been created are included in the `create_gt_data.R`
81
+#' script, included in the `scripts` folder of the `GeneTonic` package.
82
+#' 
83
+#' @family pathway-analysis-results
84
+#'
85
+#' @references Alasoo, et al. "Shared genetic effects on chromatin and gene
86
+#' expression indicate a role for enhancer priming in immune response",
87
+#' Nature Genetics, January 2018 doi: 10.1038/s41588-018-0046-7.
88
+#'
89
+#' @name gostres_macrophage
90
+#' @docType data
91
+NULL
68 92