annotate tools/mothur/normalize.shared.xml @ 0:ee4fee239fe7 draft default tip

planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
author sanbi-uwc
date Fri, 03 Jun 2016 09:32:47 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
1 <tool profile="16.07" id="mothur_normalize_shared" name="Normalize.shared" version="@WRAPPER_VERSION@.0">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
2 <description>Normalize the number of sequences per group to a specified level</description>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
3 <macros>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
4 <import>macros.xml</import>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
5 </macros>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
6 <expand macro="requirements"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
7 <expand macro="version_command"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
8 <command detect_errors="aggressive"><![CDATA[
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
9 echo 'normalize.shared(
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
10 #if $otu.is_of_type("mothur.relabund"):
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
11 relabund=$otu
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
12 #elif $otu.is_of_type("mothur.shared"):
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
13 shared=$otu,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
14 makerelabund=$makerelabund
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
15 #end if
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
16 #if $label:
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
17 ,label=${ str($label).replace(",","-") }
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
18 #end if
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
19 #if $groups:
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
20 ,groups=${ str($groups).replace(",","-") }
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
21 #end if
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
22 #if $method:
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
23 ,method=${ str($method).replace(",","-") }
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
24 #end if
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
25 )'
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
26 | sed 's/ //g' ## mothur trips over whitespace
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
27 | mothur &&
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
28
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
29 ## move output files to correct destination
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
30 prefix="$otu" &&
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
31 mv mothur.*.logfile "$logfile" &&
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
32 mv \${prefix%.dat}*.shared .
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
33 ]]></command>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
34 <inputs>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
35 <param name="otu" type="data" format="mothur.shared,mothur.relabund" label="shared,relabund - OTU Shared or Relabund file"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
36 <param name="label" type="select" label="label - OTU Labels" multiple="true">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
37 <expand macro="labeloptions"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
38 </param>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
39 <param name="groups" type="select" label="groups - Groups to include" multiple="true">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
40 <options>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
41 <filter type="data_meta" ref="otu" key="groups"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
42 </options>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
43 </param>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
44 <param name="method" type="select" label="method - Normalization method">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
45 <option value="totalgroup" selected="true">Total Group</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
46 <option value="zscore">Z Score</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
47 </param>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
48 <param name="makerelabund" type="boolean" truevalue="true" falsevalue="false" checked="false" label="makerelabund - convert a shared file to a relabund file before you normalize"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
49 </inputs>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
50 <outputs>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
51 <data name="logfile" format="txt" label="${tool.name} on ${on_string}: logfile"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
52 <collection name="sharedfiles" type="list" label="${tool.name} on ${on_string}: norm.shared files collection">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
53 <discover_datasets pattern=".*?\.(?P&lt;designation&gt;.*)\.shared" format="mothur.shared"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
54 </collection>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
55 </outputs>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
56 <tests>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
57 <test><!-- test default settings -->
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
58 <param name="otu" value="amazon.an.shared" ftype="mothur.shared"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
59 <output_collection name="sharedfiles" count="36">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
60 <element name="0.26.norm" md5="73ad51ce74e5b3efbc1d9ec8ed6e1c07" ftype="mothur.shared"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
61 </output_collection>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
62 <expand macro="logfile-test"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
63 </test>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
64 <test><!-- test default settings -->
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
65 <param name="otu" value="amazon.an.relabund" ftype="mothur.relabund"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
66 <param name="label" value="0.03,0.05,0.22,0.26"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
67 <param name="groups" value="forest,pasture"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
68 <param name="method" value="zscore"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
69 <output_collection name="sharedfiles" count="4">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
70 <element name="0.26.norm" md5="1204d65c732fd880585180e956610026" ftype="mothur.shared"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
71 </output_collection>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
72 <expand macro="logfile-test"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
73 </test>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
74 </tests>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
75 <help>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
76 <![CDATA[
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
77
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
78 @MOTHUR_OVERVIEW@
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
79
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
80 **Command Documenation**
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
81
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
82 The normalize.shared_ command normalizes the number of sequences per group to a specified level. The input is a shared_ or relabund_ file.
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
83
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
84 .. _shared: http://www.mothur.org/wiki/Shared_file
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
85 .. _relabund: http://www.mothur.org/wiki/Get.relabund
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
86 .. _normalize.shared: http://www.mothur.org/wiki/Normalize.shared
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
87 ]]>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
88 </help>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
89 <expand macro="citations"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
90 </tool>