annotate build/tools/ORApathwayEnrichment/ORApathwayEnrichment.xml @ 10:6a112eaf8f38 draft

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