annotate README.rst @ 14:35fc495473ec draft

planemo upload commit b8671ffe2e12dc6612b971a3e6e1dc71496aefd0
author proteore
date Fri, 24 Jan 2020 05:13:23 -0500
parents 8eaa43ba1bfc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
ce67a81ef27e planemo upload commit f338a1cf9a782938c228f9bd0ea19ef22eec35d8-dirty
proteore
parents: 2
diff changeset
1 Wrapper for topGO Tool
ce67a81ef27e planemo upload commit f338a1cf9a782938c228f9bd0ea19ef22eec35d8-dirty
proteore
parents: 2
diff changeset
2 ======================
0
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
3
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
4 **Authors**
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
5
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
6 Alexa A and Rahnenfuhrer J (2016). topGO: Enrichment Analysis for Gene Ontology. R package version 2.30.0.
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
7
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
8 **Galaxy integration**
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
9
10
e3430084c996 planemo upload commit ad5f1c5a1a71d7fa2bc8bac408856aa80b0fc2a3
proteore
parents: 6
diff changeset
10 Lisa Perus, T.P. Lien Nguyen, Florence Combes, Yves Vandenbrouck CEA, INSERM, CNRS, Grenoble-Alpes University, BIG Institute, FR
0
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
11
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
12 Sandra Dérozier, Olivier Rué, Christophe Caron, Valentin Loux INRA, Paris-Saclay University, MAIAGE Unit, Migale Bioinformatics platform
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
13
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
14 This work has been partially funded through the French National Agency for Research (ANR) IFB project.
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
15
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
16 Contact support@proteore.org for any questions or concerns about the Galaxy implementation of this tool.
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
17
6
ce67a81ef27e planemo upload commit f338a1cf9a782938c228f9bd0ea19ef22eec35d8-dirty
proteore
parents: 2
diff changeset
18 ----------------------
0
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
19
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
20 **Galaxy component based on R package topGO.**
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
21
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
22 **Input required**
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
23
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
24 This component works with Ensembl gene ids (e.g : ENSG0000013618). You can
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
25 copy/paste these identifiers or supply a tabular file (.csv, .tsv, .txt, .tab)
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
26 where there are contained.
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
27
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
28 **Principle**
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
29
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
30 This component provides the GO terms representativity of a gene list in one ontology category (Biological Process "BP", Cellular Component "CC", Molecular Function "MF"). This representativity is evaluated in comparison to the background list of all human genes associated associated with GO terms of the chosen category (BP,CC,MF). This background is given by the R package "org.Hs.eg.db", which is a genome wide association package for **human**.
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
31
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
32 **Output**
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
33
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
34 Three kind of outputs are available : a textual output, a barplot output and
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
35 a dotplot output.
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
36
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
37 *Textual output* :
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
38 The text output lists all the GO-terms that were found significant under the specified threshold.
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
39
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
40
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
41 The different fields are as follow :
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
42
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
43 - Annotated : number of genes in org.Hs.eg.db which are annotated with the GO-term.
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
44
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
45 - Significant : number of genes belonging to your input which are annotated with the GO-term.
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
46
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
47 - Expected : show an estimate of the number of genes a node of size Annotated would have if the significant genes were to be randomly selected from the gene universe.
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
48
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
49 - pvalues : pvalue obtained after the test
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
50
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
51 - ( qvalues : additional column with adjusted pvalues )
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
52
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
53
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
54 **Tests**
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
55
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
56 topGO provides a classic fisher test for evaluating if some GO terms are over-represented in your gene list, but other options are also provided (elim, weight01,parentchild). For the merits of each option and their algorithmic descriptions, please refer to topGO manual :
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
57 https://bioconductor.org/packages/release/bioc/vignettes/topGO/inst/doc/topGO.pdf
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
58
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
59 **Multiple testing corrections**
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
60
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
61 Furthermore, the following corrections for multiple testing can also be applied :
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
62 - holm
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
63 - hochberg
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
64 - hommel
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
65 - bonferroni
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
66 - BH
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
67 - BY
472ad7da3d92 planemo upload commit 9f9e8b72a239e58b5087b2b3737262c25cc2671e-dirty
proteore
parents:
diff changeset
68 - fdr
12
8eaa43ba1bfc planemo upload commit 4ba1ebe7b3f5e3fabf78b5fed7ed0b92e2cbf9e5-dirty
proteore
parents: 10
diff changeset
69
8eaa43ba1bfc planemo upload commit 4ba1ebe7b3f5e3fabf78b5fed7ed0b92e2cbf9e5-dirty
proteore
parents: 10
diff changeset
70 **Packages used**
8eaa43ba1bfc planemo upload commit 4ba1ebe7b3f5e3fabf78b5fed7ed0b92e2cbf9e5-dirty
proteore
parents: 10
diff changeset
71 - bioconductor-org.hs.eg.db v3.5.0
8eaa43ba1bfc planemo upload commit 4ba1ebe7b3f5e3fabf78b5fed7ed0b92e2cbf9e5-dirty
proteore
parents: 10
diff changeset
72 - bioconductor-org.mm.eg.db v3.5.0
8eaa43ba1bfc planemo upload commit 4ba1ebe7b3f5e3fabf78b5fed7ed0b92e2cbf9e5-dirty
proteore
parents: 10
diff changeset
73 - bioconductor-org.rn.eg.db v3.5.0
8eaa43ba1bfc planemo upload commit 4ba1ebe7b3f5e3fabf78b5fed7ed0b92e2cbf9e5-dirty
proteore
parents: 10
diff changeset
74 - bioconductor-annotationdbi v1.40.0
8eaa43ba1bfc planemo upload commit 4ba1ebe7b3f5e3fabf78b5fed7ed0b92e2cbf9e5-dirty
proteore
parents: 10
diff changeset
75 - bioconductor-go.db v3.5.0
8eaa43ba1bfc planemo upload commit 4ba1ebe7b3f5e3fabf78b5fed7ed0b92e2cbf9e5-dirty
proteore
parents: 10
diff changeset
76 - bioconductor-graph v1.56.0
8eaa43ba1bfc planemo upload commit 4ba1ebe7b3f5e3fabf78b5fed7ed0b92e2cbf9e5-dirty
proteore
parents: 10
diff changeset
77 - bioconductor-topgo v2.30.0