annotate README.rst @ 24:6d946862a105 draft default tip

"planemo upload commit bcb889be3548adf81c6d163c27a0d9afc71b8e05-dirty"
author proteore
date Mon, 17 May 2021 12:44:00 +0000
parents 537a0aae9b41
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
1 Wrapper for topGO Tool
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
2 ======================
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
3
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
4 **Authors**
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
5
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
6 Alexa A and Rahnenfuhrer J (2016). topGO: Enrichment Analysis for Gene Ontology. R package version 2.30.0.
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
7
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
8 **Galaxy integration**
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
9
19
0014bd289aff planemo upload commit 4cbd26b257f8a32e11289e28135da86b03b46622-dirty
proteore
parents: 0
diff changeset
10 Lisa Perus, T.P. Lien Nguyen, Florence Combes, Yves Vandenbrouck CEA, INSERM, CNRS, Grenoble-Alpes University, BIG Institute, FR
0
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
11
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
12 Sandra Dérozier, Olivier Rué, Christophe Caron, Valentin Loux INRA, Paris-Saclay University, MAIAGE Unit, Migale Bioinformatics platform
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
13
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
14 This work has been partially funded through the French National Agency for Research (ANR) IFB project.
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
15
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
16 Contact support@proteore.org for any questions or concerns about the Galaxy implementation of this tool.
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
17
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
18 ----------------------
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
19
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
20 **Galaxy component based on R package topGO.**
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
21
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
22 **Input required**
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
23
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
24 This component works with Ensembl gene ids (e.g : ENSG0000013618). You can
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
25 copy/paste these identifiers or supply a tabular file (.csv, .tsv, .txt, .tab)
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
26 where there are contained.
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
27
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
28 **Principle**
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
29
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-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**.
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
31
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
32 **Output**
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
33
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
34 Three kind of outputs are available : a textual output, a barplot output and
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
35 a dotplot output.
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
36
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
37 *Textual output* :
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
38 The text output lists all the GO-terms that were found significant under the specified threshold.
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
39
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
40
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
41 The different fields are as follow :
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
42
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
43 - Annotated : number of genes in org.Hs.eg.db which are annotated with the GO-term.
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
44
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
45 - Significant : number of genes belonging to your input which are annotated with the GO-term.
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
46
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-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.
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
48
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
49 - pvalues : pvalue obtained after the test
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
50
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
51 - ( qvalues : additional column with adjusted pvalues )
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
52
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
53
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
54 **Tests**
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
55
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-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 :
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
57 https://bioconductor.org/packages/release/bioc/vignettes/topGO/inst/doc/topGO.pdf
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
58
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
59 **Multiple testing corrections**
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
60
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
61 Furthermore, the following corrections for multiple testing can also be applied :
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
62 - holm
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
63 - hochberg
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
64 - hommel
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
65 - bonferroni
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
66 - BH
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
67 - BY
92dfcfb03add planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
68 - fdr
20
537a0aae9b41 planemo upload commit 065ae340a41e0cf514fe067cb72b6994327163f3-dirty
proteore
parents: 19
diff changeset
69
537a0aae9b41 planemo upload commit 065ae340a41e0cf514fe067cb72b6994327163f3-dirty
proteore
parents: 19
diff changeset
70 **Packages used**
537a0aae9b41 planemo upload commit 065ae340a41e0cf514fe067cb72b6994327163f3-dirty
proteore
parents: 19
diff changeset
71 - bioconductor-org.hs.eg.db v3.5.0
537a0aae9b41 planemo upload commit 065ae340a41e0cf514fe067cb72b6994327163f3-dirty
proteore
parents: 19
diff changeset
72 - bioconductor-org.mm.eg.db v3.5.0
537a0aae9b41 planemo upload commit 065ae340a41e0cf514fe067cb72b6994327163f3-dirty
proteore
parents: 19
diff changeset
73 - bioconductor-org.rn.eg.db v3.5.0
537a0aae9b41 planemo upload commit 065ae340a41e0cf514fe067cb72b6994327163f3-dirty
proteore
parents: 19
diff changeset
74 - bioconductor-annotationdbi v1.40.0
537a0aae9b41 planemo upload commit 065ae340a41e0cf514fe067cb72b6994327163f3-dirty
proteore
parents: 19
diff changeset
75 - bioconductor-go.db v3.5.0
537a0aae9b41 planemo upload commit 065ae340a41e0cf514fe067cb72b6994327163f3-dirty
proteore
parents: 19
diff changeset
76 - bioconductor-graph v1.56.0
537a0aae9b41 planemo upload commit 065ae340a41e0cf514fe067cb72b6994327163f3-dirty
proteore
parents: 19
diff changeset
77 - bioconductor-topgo v2.30.0