annotate tools/mapping/ORApathwayEnrichment/ORApathwayEnrichment.xml @ 8:1274e2a62479 draft default tip

planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
author metexplore
date Wed, 26 Jul 2023 15:33:45 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
2 <tool id="met4j_ORApathwayEnrichment" name="ORApathwayEnrichment" version="MET4J_VERSION_TEST">
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
3 <description>Perform Over Representation Analysis for Pathway Enrichment, using one-tailed exact Fisher Test.
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
4 The fisher exact test compute the probability p to randomly get the given set of value.
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
5 This version compute the probability to get at least the given overlap between the given set and the given modality :
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
6 Sum the hypergeometric probability with increasing target/query intersection cardinality.
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
7
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
8 The hypergeometric probability is computed from the following contingency table entries.
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
9 (value in cells correspond to the marginal totals of each intersection groups)
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
10 Query !Query
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
11 Target a b
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
12 !Target c d
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
13
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
14 The probability of obtaining the set of value is computed as following:
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
15 p = ((a+b)!(c+d)!(a+c)!(b+d)!)/(a!b!c!d!(a+b+c+d)!)
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
16
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
17 The obtained p-value is then adjusted for multiple testing using one of the following methods:
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
18 - Bonferroni: adjusted p-value = p*n
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
19 - Benjamini-Hochberg: adjusted p-value = p*n/k
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
20 - Holm-Bonferroni: adjusted p-value = p*(n+1-k)
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
21 n : number of tests; k : pvalue rank</description>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
22 <xrefs>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
23 <xref type="bio.tools">met4j</xref>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
24 </xrefs>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
25 <requirements>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
26 <container type="singularity">oras://registry.forgemia.inra.fr/metexplore/met4j/met4j-singularity:MET4J_VERSION_TEST</container>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
27 </requirements>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
28 <command detect_errors="exit_code"><![CDATA[sh /usr/bin/met4j.sh mapping.ORApathwayEnrichment#if str($th) != 'nan':
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
29 -th "$th"
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
30 #end if
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
31 -s "$sbml"
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
32 -i "$input"
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
33 #if str($corr):
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
34 -c "$corr"
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
35 #end if
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
36 -o "$outputFile"
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
37 ]]></command>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
38 <inputs>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
39 <param argument="-th" label="threshold to select significant pathways. No filtering if &lt;=0" name="th" optional="true" type="float" value="0.0"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
40 <param argument="-s" format="sbml" label="Input model : SBML file with pathway annotation" name="sbml" optional="false" type="data" value=""/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
41 <param argument="-i" format="tsv" label="Input data : Compounds of interest file, as one SBML specie identifier per line" name="input" optional="false" type="data" value=""/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
42 <param argument="-c" label="Method for multiple testing p-value adjustment." name="corr" optional="true" type="select" value="BenjaminiHochberg">
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
43 <option value="Bonferroni">Bonferroni</option>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
44 <option selected="true" value="BenjaminiHochberg">BenjaminiHochberg</option>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
45 <option value="HolmBonferroni">HolmBonferroni</option>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
46 </param>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
47 </inputs>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
48 <outputs>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
49 <data format="tsv" name="outputFile"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
50 </outputs>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
51 <tests>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
52 <test>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
53 <param name="sbml" value="XF_network.sbml"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
54 <param name="input" value="XF_network_C_NOI.txt"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
55 <output name="outputFile">
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
56 <assert_contents>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
57 <has_n_columns n="3"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
58 <has_n_lines n="3"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
59 </assert_contents>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
60 </output>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
61 </test>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
62 <test>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
63 <param name="sbml" value="XF_network.sbml"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
64 <param name="input" value="XF_network_C_NOI.txt"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
65 <param name="corr" value="HolmBonferroni"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
66 <param name="th" value="0.005"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
67 <output name="outputFile">
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
68 <assert_contents>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
69 <has_n_columns n="3"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
70 <has_n_lines n="2"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
71 </assert_contents>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
72 </output>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
73 </test>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
74 </tests>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
75 <help><![CDATA[Perform Over Representation Analysis for Pathway Enrichment, using one-tailed exact Fisher Test.]]></help>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
76 <citations/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
77 </tool>