annotate goenrichment.xml @ 0:d5273661bace draft default tip

Uploaded
author ubi.igc
date Thu, 24 May 2018 14:01:53 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
1 <tool id="goenrichment" name="GOEnrichment" version="2.0.0">
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
2 <description>performs GO enrichment analysis of a set of gene products</description>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
3 <requirements>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
4 <requirement type="package" version="8.0.112">java-jdk</requirement>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
5 </requirements>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
6 <stdio>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
7 <exit_code range="1:" level="fatal" description="Fatal ERROR exit code greater than 1" />
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
8 </stdio>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
9 <command interpreter="java -jar">GOEnrichment.jar
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
10 --go $go
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
11 --annotation $annotation
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
12 --study $study
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
13 #if str($population) != 'None'
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
14 --population $population
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
15 #end if
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
16 --correction $correction
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
17 #if str($summarize) == 'true'
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
18 --summarize_output
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
19 #end if
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
20 #if str($singletons) == 'true'
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
21 --ignore_singletons
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
22 #end if
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
23 #if str($relations) == 'true'
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
24 --use_all_relations
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
25 #end if
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
26 --graph_format $graph
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
27 --cut_off $cutoff
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
28 --mf_result $mf_result
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
29 --bp_result $bp_result
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
30 --cc_result $cc_result
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
31 --mf_graph $mf_graph
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
32 --bp_graph $bp_graph
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
33 --cc_graph $cc_graph
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
34 </command>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
35 <inputs>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
36 <param name="go" type="data" format="obo,owl" label="Gene Ontology File" help="Gene Ontology file in OBO or OWL format (see http://geneontology.org/page/download-ontology)"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
37 <param name="annotation" type="data" format="txt" label="Gene Product Annotation File" help="Tabular file containing annotations from gene products to GO terms (in GAF or BLAST2GO format, or a simple two-column table)"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
38 <param name="study" type="data" format="txt" label="Study Set File" help="File containing the gene products corresponding to the study set (one per line)"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
39 <param name="population" type="data" format="txt" optional="true" label="Population Set File (Optional)" help="File containing the gene products corresponding to the population set (one per line). If no file is submitted, the population set will be the set of all gene products listed in the annotation file."/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
40 <param name="correction" type="select" label="Multiple Test Correction" help="The multiple test correction method to use (Benjamini-Hochberg is recommended).">
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
41 <option value="Benjamini-Hochberg" selected="true"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
42 <option value="SDA"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
43 <option value="Bonferroni-Holm"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
44 <option value="Sidak"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
45 <option value="Bonferroni"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
46 </param>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
47 <param name="cutoff" type="select" label="P-Value Cut-Off" help="The corrected p-value (or q-value) cut-off to apply for the graph output.">
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
48 <option value="1.0"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
49 <option value="0.1"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
50 <option value="0.05"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
51 <option value="0.01" selected="true"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
52 </param>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
53 <param name="graph" type="select" label="Output Graph Format" help="The format of the output graphs (png, svg, or txt for importing into cytoscape).">
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
54 <option value="png" selected="true"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
55 <option value="svg"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
56 <option value="txt"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
57 </param>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
58 <param name="summarize" type="boolean" checked="true" label="Summarize Output" help="Whether to produce a summarized list of GO terms or the full list of those that are statistically significant"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
59 <param name="singletons" type="boolean" checked="true" label="Exclude Singletons" help="Whether to exclude GO terms that are annotated to a single gene product in the study set"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
60 <param name="relations" type="boolean" checked="false" label="Use All Relations" help="Whether to infer annotations through 'part_of' and other non-hierarchical relationships, or only through 'is_a' relations"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
61 </inputs>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
62 <outputs>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
63 <data name="mf_result" format="tabular" label="MF Result File"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
64 <data name="bp_result" format="tabular" label="BP Result File"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
65 <data name="cc_result" format="tabular" label="CC Result File"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
66 <data name="mf_graph" format="png" label="MF Graph File">
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
67 <change_format>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
68 <when input="graph" value="svg" format="svg"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
69 <when input="graph" value="txt" format="txt"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
70 </change_format>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
71 </data>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
72 <data name="bp_graph" format="png" label="BP Graph File">
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
73 <change_format>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
74 <when input="graph" value="svg" format="svg"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
75 <when input="graph" value="txt" format="txt"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
76 </change_format>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
77 </data>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
78 <data name="cc_graph" format="png" label="CC Graph File">
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
79 <change_format>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
80 <when input="graph" value="svg" format="svg"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
81 <when input="graph" value="txt" format="txt"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
82 </change_format>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
83 </data>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
84 </outputs>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
85 <tests>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
86 <test>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
87 <param name="go" ftype="obo" value="goslim_generic.obo"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
88 <param name="annotation" ftype="txt" value="goslim_annotations_mouse.txt"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
89 <param name="study" ftype="txt" value="mouse_up.txt"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
90 <param name="summarize" value="false"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
91 <output name="mf_result" ftype="tabular" file="MF_result.txt" lines_diff="0"/>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
92 </test>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
93 </tests>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
94 <help>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
95 .. class:: infomark
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
96
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
97 GOEnrichment is a Java application that can be used to analyze gene product sets (e.g., from microarray or RNAseq experiments) for enriched GO terms.
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
98
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
99 -----
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
100
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
101 .. class:: infomark
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
102
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
103 GOEnrichment requires:
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
104
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
105 - -A Gene Ontology file in either OBO or OWL format (see http://geneontology.org/page/download-ontology).
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
106 - -A tabular annotation file in GAF (http://geneontology.org/page/download-annotations) format, BLAST2GO format, or a simple two-column table (e.g. from BioMart) with gene product ids in the first column and GO terms in the second one.
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
107 - -A list of gene products comprising the study set (a flat text file with one gene product per line).
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
108 - -Optionally, a list of gene products comprising the population set (if none is submitted, the population set will be the set of gene products listed in the annotation file).
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
109
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
110 -----
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
111
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
112 .. class:: infomark
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
113
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
114 GOEnrichment produces a tabular result file and a graph file for each GO type (MF, BP and CC):
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
115
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
116 - -The result file is a tabular list of all GO terms present in the study set and their respective p-values.
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
117 - -The graph file can be either a png image, an svg image, or a text file for importing into cytoscape (together with the result file).
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
118
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
119 -----
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
120
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
121 .. class:: infomark
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
122
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
123 The graph is colored by p-value: terms with p-value above cut-off appear in white; and the color gets darker as the p-value decreases
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
124 (see the scale at https://github.com/DanFaria/GOEnrichment/blob/master/Scale.png). In addition to the name of each GO term, the graph
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
125 shows its frequency in the study set. Dashed edges indicate that one or more intermediate terms were ommited from the graph.
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
126
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
127 -----
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
128
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
129 .. class:: warningmark
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
130
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
131 Gene products listed in either the study or population set files that are not present in the annotation file will be ignored.
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
132 </help>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
133
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
134 <citations>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
135 <citation type="bibtex">
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
136 @misc{githubgoenrichment,
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
137 author = {Faria, Daniel},
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
138 year = {2017},
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
139 title = {GOEnrichment},
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
140 publisher = {GitHub},
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
141 journal = {GitHub repository},
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
142 url = {https://github.com/DanFaria/GOEnrichment},
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
143 }</citation>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
144 </citations>
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
145
d5273661bace Uploaded
ubi.igc
parents:
diff changeset
146 </tool>