annotate humann2_associate.xml @ 0:b6f52c19973d draft

planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
author iuc
date Tue, 01 Aug 2017 07:56:34 -0400
parents
children e57b437186b3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
1 <tool id="humann2_associate" name="Associate" version="@WRAPPER_VERSION@.0">
b6f52c19973d 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>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
3 <macros>
b6f52c19973d 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>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
5 </macros>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
7 <expand macro="version"/>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
9 humann2_associate
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
10 --input '$input'
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
11 --focal-metadatum '$focal_metadatum'
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
12 --last-metadatum '$last_metadatum'
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
13 --focal-type '$focal_type'
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
14 --fdr '$fdr'
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
15 --output '$associated_table'
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
16 ]]></command>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
17 <inputs>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
18 <param argument="--input" type="data" format="tsv,tabular" label="HUMAnN2 table with metadata rows at the top"/>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
19 <param name="focal_metadatum" argument="--focal-metadatum" type="text" value="" label="Metadatum to test vs. community feature totals"/>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
20 <param name="last_metadatum" argument="--last-metadatum" type="text" value="" label="End of metadata rows"/>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
21 <param name="focal_type" argument="--focal-type" type="select" label="Metadatum type">
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
22 <option value="continuous">Continuous</option>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
23 <option value="categorical">Categorical</option>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
24 </param>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
25 <param argument="--fdr" type="float" value="0.2" label="FDR threshold"/>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
26 </inputs>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
27 <outputs>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
28 <data format="tabular" name="associated_table" label="${tool.name} on ${on_string}" />
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
29 </outputs>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
30 <tests>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
31 <test>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
32 <param name="input" value="hmp_pathabund.txt"/>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
33 <param name="focal_metadatum" value="STSite"/>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
34 <param name="last_metadatum" value="STSite"/>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
35 <param name="focal_type" value="categorical"/>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
36 <param name="fdr" value="0.2"/>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
37 <output name="associated_table" md5="d37e750915a6895145540d15074a9c15"/>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
38 </test>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
39 </tests>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
40 <help><![CDATA[
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
41 @HELP_HEADER@
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
42
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
43 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.
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
44 ]]></help>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
45 <expand macro="citations"/>
b6f52c19973d planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit 6753a2c0fec9222f5977cab43a855c63fa9f7bee
iuc
parents:
diff changeset
46 </tool>