Browse code

filling in manpage for the package

Federico Marini authored on 26/05/2021 09:11:07
Showing 2 changed files

... ...
@@ -1,8 +1,17 @@
1 1
 #' GeneTonic
2 2
 #'
3 3
 #' `GeneTonic` is a Bioconductor package that provides an interactive Shiny-based
4
-#'  graphical user interface for...
5
-#'
4
+#' graphical user interface for streamlining the interpretation of RNA-seq data
5
+#'  
6
+#' `GeneTonic` simplifies and optimizes the integration of all components of 
7
+#' Diffeential Expression analysis, with functional enrichment analyis and the 
8
+#' original expression quantifications.
9
+#' It does so in a way that makes it easier to generate insightful observations 
10
+#' and hypothesis - combining the benefits of interactivity and reproducibility, 
11
+#' e.g. by capturing the features and gene sets of interest highlighted during 
12
+#' the live session, and creating an HTML report as an artifact where text, 
13
+#' code, and output coexist.
14
+#'  
6 15
 #' @author Federico Marini \email{marinif@@uni-mainz.de}
7 16
 #'
8 17
 #' @importFrom AnnotationDbi Definition GOID Ontology Secondary Synonym Term
... ...
@@ -6,7 +6,16 @@
6 6
 \title{GeneTonic}
7 7
 \description{
8 8
 \code{GeneTonic} is a Bioconductor package that provides an interactive Shiny-based
9
-graphical user interface for...
9
+graphical user interface for streamlining the interpretation of RNA-seq data
10
+
11
+\code{GeneTonic} simplifies and optimizes the integration of all components of
12
+Diffeential Expression analysis, with functional enrichment analyis and the
13
+original expression quantifications.
14
+It does so in a way that makes it easier to generate insightful observations
15
+and hypothesis - combining the benefits of interactivity and reproducibility,
16
+e.g. by capturing the features and gene sets of interest highlighted during
17
+the live session, and creating an HTML report as an artifact where text,
18
+code, and output coexist.
10 19
 }
11 20
 \author{
12 21
 Federico Marini \email{marinif@uni-mainz.de}