Browse code

Updated documentation for geneinfo_2_html

Federico Marini authored on 12/02/2020 14:19:20
Showing 1 changed files

... ...
@@ -4,11 +4,17 @@
4 4
 \alias{geneinfo_2_html}
5 5
 \title{Information on a gene}
6 6
 \usage{
7
-geneinfo_2_html(gene_id)
7
+geneinfo_2_html(gene_id, res_de = NULL)
8 8
 }
9 9
 \arguments{
10 10
 \item{gene_id}{Character specifying the gene identifier for which to retrieve
11 11
 information}
12
+
13
+\item{res_de}{A \code{DESeqResults} object, storing the result of the differential
14
+expression analysis. If not provided, the experiment-related information is not
15
+shown, and only some generic info on the identifier is displayed.
16
+The information about the gene is retrieved by matching on the \code{SYMBOL} column,
17
+which should be provided in \code{res_de}.}
12 18
 }
13 19
 \value{
14 20
 HTML content related to a gene identifier, to be displayed in