annotate categorize_by_function.xml @ 5:36e87158ef04 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit ee7bd710f5194337040a592a5c9069bc3486a68f"
author iuc
date Sat, 18 Dec 2021 16:06:21 +0000
parents fd5533e57354
children 8c7bafdb713f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
36e87158ef04 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit ee7bd710f5194337040a592a5c9069bc3486a68f"
iuc
parents: 1
diff changeset
1 <tool id="picrust_categorize" name="Categorize" version="@TOOL_VERSION@.0">
1
fd5533e57354 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents: 0
diff changeset
2 <description>by collapsing hierarchical data to a specified functional level</description>
0
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
3 <macros>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
4 <import>macros.xml</import>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
5 </macros>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
7 <expand macro="version_command"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
8 <command detect_errors="aggressive"><![CDATA[
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
9 categorize_by_function.py
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
10 -i '$input_fp'
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
11 -c $metadata_category
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
12 -l $level
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
13 -o tempbiom
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
14
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
15 @OUTPUT_CONVERSION_COMMANDS@
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
16 ]]></command>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
17 <inputs>
1
fd5533e57354 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents: 0
diff changeset
18 <param argument="--input_fp" format="biom1,h5" type="data" label="Input file" help="Biom file that is output from the PICRISt predict tool"/>
0
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
19 <param argument="--metadata_category" type="select" multiple="false" label="Metadata category that describes the hierarchy" help="">
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
20 <option value="KEGG_Pathways" selected="true">KEGG Pathways</option>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
21 <option value="COG_Category">COG Category</option>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
22 <option value="taxonomy">Using taxonomy metadata</option>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
23 </param>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
24 <param argument="--level" type="integer" value="3" min="1" label="Hierarchy Level"
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
25 help="a value of 1 is the highest level, and any higher value nears the leaves of the hierarchy. For instance, if the hierarchy contains 4 levels, specifying 3 would collapse at one level above being fully specified"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
26 <expand macro="biom_format_select"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
27 </inputs>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
28 <outputs>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
29 <expand macro="biom_output"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
30 </outputs>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
31 <tests>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
32 <test> <!-- test with Kegg Pathways and json output -->
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
33 <param name="input_fp" value="predicted_metagenomes.L3.biom"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
34 <param name="metadata_category" value="KEGG_Pathways"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
35 <param name="level" value="2"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
36 <param name="output_type" value="json"/>
1
fd5533e57354 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents: 0
diff changeset
37 <output name="out_biom" ftype="biom1">
0
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
38 <assert_contents>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
39 <has_text text="Biological Observation Matrix"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
40 <has_text text="generated_by"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
41 <has_text text="KEGG_Pathways"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
42 <has_text text="Cancers"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
43 <not_has_text text="ABC transporters"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
44 </assert_contents>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
45 </output>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
46 </test>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
47 <test> <!-- test with COG categories and classic output -->
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
48 <param name="input_fp" value="cog_predicted_metagenomes.L2.biom"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
49 <param name="metadata_category" value="COG_Category"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
50 <param name="level" value="1"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
51 <param name="output_type" value="tsv"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
52 <output name="out_biom" ftype="tabular" md5="7682875d365f884b399ffa521952dbd8"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
53 </test>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
54 <test> <!-- test with taxonomy metadata and hdf5 output -->
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
55 <param name="input_fp" value="observation_table.biom"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
56 <param name="metadata_category" value="taxonomy"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
57 <param name="level" value="1"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
58 <param name="output_type" value="hdf5"/>
1
fd5533e57354 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents: 0
diff changeset
59 <output name="out_biom" ftype="h5" file="categorize_biom.hdf5" compare="sim_size"/>
0
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
60 </test>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
61 </tests>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
62 <help>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
63 <![CDATA[
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
64 @PICRUST_OVERVIEW@
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
65
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
66 **Command Documentation**
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
67
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
68 This module collapses hierarchical data to a specified level for PICRUSt predictions. For instance, often it is useful to examine KEGG results from a higher level within the pathway hierarchy.
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
69 Many genes are sometimes involved in multiple pathways, and in these circumstances (also know as a one-to-many relationship), the gene is counted for each pathway.
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
70
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
71 **Input file:** Output file from the predict tool
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
72
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
73 ]]>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
74 </help>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
75 <expand macro="citations"/>
a94f4d96045c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
76 </tool>