Browse code

Adds MineICA, SomatiCA and lpNet to the repos.

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

Marc Carlson authored on 05/02/2013 22:15:53
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,88 @@
1
+\name{mergeGostatsResults}
2
+\alias{mergeGostatsResults}
3
+\title{Merge enrichment results obtained for different databases into one file per component.}
4
+\usage{
5
+  mergeGostatsResults(resPath, GOstatsPath,
6
+    rdata = "hgres", cutoffs = NULL, hgCutoff = 0.01,
7
+    cond = TRUE, pathGenes)
8
+}
9
+\arguments{
10
+  \item{resPath}{The global path where results of ICA
11
+  analysis are written}
12
+
13
+  \item{GOstatsPath}{The path within argument
14
+  \code{resPath} where files will be written}
15
+
16
+  \item{rdata}{The name of the rdata file containing the
17
+  enrichment analysis of all components}
18
+
19
+  \item{cutoffs}{The threshold(s) used to select genes used
20
+  in enrichment analysis}
21
+
22
+  \item{hgCutoff}{The p-value threshold}
23
+
24
+  \item{cond}{A logical indicating whether the calculation
25
+  has been conditioned on the GO structure, see
26
+  \code{\link[Category:GOHyperGParams-class]{GOHyperGParams}}.}
27
+
28
+  \item{pathGenes}{The path where HTML files containing
29
+  gene projections for each component are located}
30
+}
31
+\value{
32
+  NULL
33
+}
34
+\description{
35
+  This function is internal and called by function
36
+  \code{runEnrich}. It merges enrichment results obtained
37
+  with either KEGG, GO, or both databases into one file.
38
+}
39
+\details{
40
+  This function writes an HTML file per component,
41
+  containing the outputs of the enrichment tests computed
42
+  through the function \code{\link[Category]{hyperGTest}}.
43
+  The results of the enrichment tests are loaded from .rda
44
+  files located in
45
+  \code{resPath(icaSet)}/GOstatsEnrichAnalysis/byDb/'db-name'/('ontology-name'/).
46
+  The results obtained for the different
47
+  databases/ontologies are then merged into an array for
48
+  each component, this array is written as an HTML file in
49
+  the directory
50
+  \code{resPath(icaSet)}/\code{zvalCutoff(params)}. The
51
+  arguments \code{hgCutoff} and \code{cond} have to be
52
+  provided because they will be used in the file names of
53
+  the resulting files.
54
+
55
+  This function makes several important assumptions: only
56
+  databases GO and KEGG have been tested, p-values are not
57
+  available for gene sets that have not been selected as
58
+  significant.
59
+
60
+  The outputs of \code{\link[Category]{hyperGTest}} that
61
+  are given in each table are: \describe{ \item{DB, ID,
62
+  Term}{The database, the gene set ID, and the gene set
63
+  name,} \item{P-value}{probability of observing the number
64
+  of genes annotated for the gene set among the selected
65
+  gene list, knowing the total number of annotated genes
66
+  among the universe}, \item{Expected counts}{expected
67
+  number of genes in the selected gene list to be found at
68
+  each tested category term/gene set,} \item{Odds
69
+  ratio}{odds ratio for each category term tested which is
70
+  an indicator of the level of enrichment of genes within
71
+  the list as against the universe,} \item{Counts}{number
72
+  of genes in the selected gene list which are annotated
73
+  for the gene set,} \item{Size}{number of genes from the
74
+  universe annotated for the gene set.}}
75
+}
76
+\author{
77
+  Anne Biton
78
+}
79
+\seealso{
80
+  \code{\link[xtable]{xtable}},
81
+  \code{\link[biomaRt]{useMart}},
82
+  \code{\link[Category]{hyperGTest}},
83
+  \code{\link[Category:GOHyperGParams-class]{GOHyperGParams}},
84
+  \code{\link{hypergeoAn}},
85
+  \code{\link{mergeGostatsResults}}
86
+}
87
+\keyword{internal}
88
+