Mercurial > repos > iuc > picrust2_add_descriptions

annotate add_descriptions.xml @ 1:c6db15773950 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/picrust/picrust2 commit f8c32a316582ff102c9b7edf3817000691ef9eea
author iuc
date Tue, 13 Aug 2024 12:10:10 +0000
parents b994cc8f3cf1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
1 <tool id="picrust2_add_descriptions" name="PICRUSt2 Add descriptions" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
2 <description>column to a function abundance table</description>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
3 <macros>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
4 <import>macros.xml</import>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
5 </macros>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
6 <expand macro="bio_tool"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
7 <expand macro="requirements"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
8 <version_command>add_descriptions.py -v</version_command>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
10 add_descriptions.py
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
11 --input '$input'
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
12 --output '$func_abun_table_description'
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
13 #if $map_file.selector == "default"
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
14 --map_type '$map_file.map_type'
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
15 #else if $map_file.selector == "custom"
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
16 --custom_map_table '$map_file.custom_map_table'
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
17 #end if
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
18 ]]></command>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
19 <inputs>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
20 <param argument="--input" type="data" format="tabular" label="Input function (gene family or pathway) abundance table"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
21 <conditional name="map_file">
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
22 <param name="selector" type="select" label="Argument specifying non-default reference files to use for sequence placement">
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
23 <option value="default" selected="true">Default mapping file</option>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
24 <option value="custom">Customized mapping file</option>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
25 </param>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
26 <when value="default">
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
27 <param argument="--map_type" type="select" label="Mapping table to use">
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
28 <option value="COG">Clusters of Orthologous Genes database (COG)</option>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
29 <option value="EC">Enzyme Commission number database (EC number)</option>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
30 <option value="KO">KEGG Orthology database (KO)</option>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
31 <option value="PFAM">Pfam database</option>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
32 <option value="TIGRFAM">TIGRFAM database</option>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
33 <option value="METACYC">Metabolic Pathway database (MetaCyc)</option>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
34 </param>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
35 </when>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
36 <when value="custom">
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
37 <param argument="--custom_map_table" type="data" format="tabular" label="Custom mapping table" help="A table with at least two columns linking function ids to descriptions for each function">
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
38 <validator type="dataset_metadata_in_range" metadata_name="columns" min="2" message="Input needs to have at least two columns"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
39 </param>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
40 </when>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
41 </conditional>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
42 </inputs>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
43 <outputs>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
44 <data name="func_abun_table_description" format="tabular" from_work_dir="added_description.tsv"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
45 </outputs>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
46 <tests>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
47 <test expect_num_outputs="1">
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
48 <param name="input" value="pred_metagenome_unstrat.tsv.gz"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
49 <conditional name="map_file">
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
50 <param name="selector" value="default"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
51 <param name="map_type" value="EC"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
52 </conditional>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
53 <output name="func_abun_table_description">
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
54 <assert_contents>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
55 <has_text text="description"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
56 <has_n_lines n="1000"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
57 </assert_contents>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
58 </output>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
59 </test>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
60 <test expect_num_outputs="1">
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
61 <param name="input" value="pred_metagenome_unstrat.tsv.gz"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
62 <conditional name="map_file">
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
63 <param name="selector" value="custom"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
64 <param name="custom_map_table" value="ec_unstrat_test.txt.gz"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
65 </conditional>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
66 <output name="func_abun_table_description">
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
67 <assert_contents>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
68 <has_text text="description"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
69 <has_n_lines n="1000"/>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
70 </assert_contents>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
71 </output>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
72 </test>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
73 </tests>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
74 <help><![CDATA[
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
75 @HELP_HEADER@
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
76
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
77 Add Descriptions
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
78 ================
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
79 Adds a description column to a function abundance table and outputs a new file.
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
80
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
81 Note
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
82 ====
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
83 The user needs to specify the input file and what type of functions are in the input table. Will throw an error if no ids overlap and otherwise will fill in "not_found" for the description of ids in the function table not in the mapfile.
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
84
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
85 Input
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
86 =====
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
87 Input function abundance table.
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
88
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
89 Output
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
90 ======
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
91 Output function abundance table with added description column.
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
92 ]]></help>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
93 <citations>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
94 <citation type="doi">10.1038/s41587-020-0548-6</citation>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
95 </citations>
b994cc8f3cf1 planemo upload for repository https://github.com/picrust/picrust2 commit 972784d909912af20cd213fc56830fee79d83ca6
iuc
parents:
diff changeset
96 </tool>