Browse code

added info for fgsea output sample data

Federico Marini authored on 28/05/2020 08:15:23
Showing 2 changed files

... ...
@@ -90,3 +90,27 @@ NULL
90 90
 #' @docType data
91 91
 NULL
92 92
 
93
+
94
+#' A sample output from fgsea
95
+#'
96
+#' A sample output object as created from a call to the `fgsea()` function, in
97
+#' the `fgsea` package, as a practical framework for performing GSEA
98
+#'
99
+#' @details This object has been created on the data from the `macrophage` package
100
+#' by analyzing downstream the differentially expressed genes
101
+#' when comparing IFNg treated samples vs naive samples, accounting
102
+#' for the different cell lines included.
103
+#'
104
+#' Details on how this object has been created are included in the `create_gt_data.R`
105
+#' script, included in the `scripts` folder of the `GeneTonic` package.
106
+#'
107
+#' @references Alasoo, et al. "Shared genetic effects on chromatin and gene
108
+#' expression indicate a role for enhancer priming in immune response",
109
+#' Nature Genetics, January 2018 doi: 10.1038/s41588-018-0046-7.
110
+#'
111
+#' @name fgseaRes
112
+#' @docType data
113
+NULL
114
+
115
+
116
+
93 117
new file mode 100644
... ...
@@ -0,0 +1,24 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/GeneTonic-data.R
3
+\docType{data}
4
+\name{fgseaRes}
5
+\alias{fgseaRes}
6
+\title{A sample output from fgsea}
7
+\description{
8
+A sample output object as created from a call to the \code{fgsea()} function, in
9
+the \code{fgsea} package, as a practical framework for performing GSEA
10
+}
11
+\details{
12
+This object has been created on the data from the \code{macrophage} package
13
+by analyzing downstream the differentially expressed genes
14
+when comparing IFNg treated samples vs naive samples, accounting
15
+for the different cell lines included.
16
+
17
+Details on how this object has been created are included in the \code{create_gt_data.R}
18
+script, included in the \code{scripts} folder of the \code{GeneTonic} package.
19
+}
20
+\references{
21
+Alasoo, et al. "Shared genetic effects on chromatin and gene
22
+expression indicate a role for enhancer priming in immune response",
23
+Nature Genetics, January 2018 doi: 10.1038/s41588-018-0046-7.
24
+}