annotate predict_metagenomes.xml @ 0:2d4c0825cfe6 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
author iuc
date Thu, 08 Dec 2016 06:28:50 -0500
parents
children 2fa7594063b1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
1 <tool id="picrust_predict_metagenomes" name="Predict Metagenome" version="@WRAPPER_VERSION@.0">
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
2 <description>create a virtual metagenome of KEGG Ortholog abundances</description>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
3 <macros>
2d4c0825cfe6 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>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
5 </macros>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
2d4c0825cfe6 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"/>
2d4c0825cfe6 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[
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
9 predict_metagenomes.py
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
10 -i '$input_data'
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
11 -o tempbiom
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
12 -c '$gg.precalc'
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
13 $normalize_by_otu
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
14 $normalize_by_function
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
15 #if $accuracy_metrics:
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
16 -a $out_summary
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
17 #end if
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
18
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
19 @OUTPUT_CONVERSION_COMMANDS@
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
20 ]]></command>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
21 <inputs>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
22 <param name="input_data" type="data" format="tabular,biom1" label="Input file"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
23 <expand macro="otu-reference-precalculated"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
24 <expand macro="biom_format_select"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
25 <param argument="normalize_by_function" type="boolean" truevalue="--normalize_by_function" falsevalue="" checked="false" label="Normalize by function?"
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
26 help="Normalizes the predicted functional abundances by dividing each abundance by the sum of functional abundances in the sample. Total sum of abundances for each sample will equal 1"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
27 <param argument="normalize_by_otu" type="boolean" truevalue="--normalize_by_otu" falsevalue="" checked="false" label="Normalize by OTU?"
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
28 help="Normalizes the predicted functional abundances by dividing each abundance by the sum of OTUs in the sample. Note: total sum of abundances for each sample will NOT equal 1"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
29 <param argument="accuracy_metrics" type="boolean" truevalue="T" falsevalue="F" checked="false" label="Calculate accuracy metrics"
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
30 help="requires that per-genome accuracy metrics were calculated during genome prediction (predict_traits tool) (e.g. there are NSTI values in the genome biom file metadata)"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
31 </inputs>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
32 <outputs>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
33 <expand macro="biom_output"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
34 <data name="out_summary" format="tabular">
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
35 <filter>accuracy_metrics</filter>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
36 </data>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
37 </outputs>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
38 <tests>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
39 <test> <!-- test with defaults -->
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
40 <param name="input_data" value="normalized_otus.biom"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
41 <param name="source" value="hist"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
42 <param name="precalc" value="16S_13_5_precalculated_minimal.tab"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
43 <param name="output_type" value="json"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
44 <output name="out_file" ftype="json">
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
45 <assert_contents>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
46 <has_text text="Biological Observation Matrix"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
47 <has_text text="generated_by"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
48 </assert_contents>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
49 </output>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
50 </test>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
51 <test> <!-- test with accuracy metrics and normalizations -->
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
52 <param name="input_data" value="otu_table_for_custom_trait_table.biom"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
53 <param name="source" value="hist"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
54 <param name="precalc" value="custom_trait_table.tab"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
55 <param name="output_type" value="tsv"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
56 <param name="accuracy_metrics" value="T"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
57 <param name="normalize_by_function" value="--normalize_by_function"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
58 <param name="normalize_by_otu" value="--normalize_by_otu"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
59 <output name="out_file" ftype="tabular">
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
60 <assert_contents>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
61 <has_text text="trait2"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
62 <has_text text="Sample4"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
63 </assert_contents>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
64 </output>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
65 <output name="out_summary" ftype="tabular">
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
66 <assert_contents>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
67 <has_line_matching expression="#Sample\tMetric\tValue"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
68 <has_text text="NSTI"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
69 <has_text text="Sample4"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
70 </assert_contents>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
71 </output>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
72 </test>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
73 </tests>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
74 <help>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
75 <![CDATA[
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
76 @PICRUST_OVERVIEW@
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
77
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
78 **Command Documentation**
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
79
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
80 This module produces a 'virtual' metagenome of KEGG Ortholog abundances for each sample in the given OTU table.
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
81
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
82 **Input file:** This should be a normalized OTU table populated by the output of the PICRUSt Normalize by Copy Number module.
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
83
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
84 ]]>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
85 </help>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
86 <expand macro="citations"/>
2d4c0825cfe6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit a933cd08ace9778a03e575e54f2b69bc5315e14c
iuc
parents:
diff changeset
87 </tool>