annotate humann2_associate.xml @ 3:1f8e523f98e6 draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/humann2 commit 8d953926efdf23d8c3fb8719341dff51a55a92f2"
author iuc
date Sun, 28 Mar 2021 06:46:49 +0000
parents 90a095e18acb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
90a095e18acb "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/humann2 commit 55eb503f50c54695ec36c3d4671c2b3e64d05f40"
iuc
parents: 0
diff changeset
1 <tool id="humann2_associate" name="Associate" version="@WRAPPER_VERSION@.1">
0
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
2 <description>HUMAnN2 functions with metadata</description>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
3 <macros>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
4 <import>humann2_macros.xml</import>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
5 </macros>
2
90a095e18acb "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/humann2 commit 55eb503f50c54695ec36c3d4671c2b3e64d05f40"
iuc
parents: 0
diff changeset
6 <expand macro="stdio"/>
0
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
7 <expand macro="requirements"/>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
8 <expand macro="version"/>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
10 humann2_associate
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
11 --input '$input'
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
12 --focal-metadatum '$focal_metadatum'
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
13 --last-metadatum '$last_metadatum'
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
14 --focal-type '$focal_type'
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
15 --fdr '$fdr'
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
16 --output '$associated_table'
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
17 ]]></command>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
18 <inputs>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
19 <param argument="--input" type="data" format="tsv,tabular" label="HUMAnN2 table with metadata rows at the top"/>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
20 <param name="focal_metadatum" argument="--focal-metadatum" type="text" value="" label="Metadatum to test vs. community feature totals"/>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
21 <param name="last_metadatum" argument="--last-metadatum" type="text" value="" label="End of metadata rows"/>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
22 <param name="focal_type" argument="--focal-type" type="select" label="Metadatum type">
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
23 <option value="continuous">Continuous</option>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
24 <option value="categorical">Categorical</option>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
25 </param>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
26 <param argument="--fdr" type="float" value="0.2" label="FDR threshold"/>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
27 </inputs>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
28 <outputs>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
29 <data format="tabular" name="associated_table" label="${tool.name} on ${on_string}" />
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
30 </outputs>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
31 <tests>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
32 <test>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
33 <param name="input" value="hmp_pathabund.txt"/>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
34 <param name="focal_metadatum" value="STSite"/>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
35 <param name="last_metadatum" value="STSite"/>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
36 <param name="focal_type" value="categorical"/>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
37 <param name="fdr" value="0.2"/>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
38 <output name="associated_table" md5="d37e750915a6895145540d15074a9c15"/>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
39 </test>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
40 </tests>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
41 <help><![CDATA[
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
42 @HELP_HEADER@
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
43
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
44 When associating metadata with HUMAnN2 features, it is often beneficial to associate with community totals and avoid testing each individual feature stratification (to improve statistical power). This is the approach used by the HUMAnN2 utility script humann2_associate, which can compare feature totals across samples with 1) a single continuous metadatum (via the Spearman Correlation) or 2) a single categorical metadatum (via the Kruskal-Wallis H-test). Notably, this is a naive approach to association, but it is useful for tutorial purposes.
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
45 ]]></help>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
46 <expand macro="citations"/>
951cfc741d35 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
47 </tool>