annotate tools/mothur/make.lefse.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_make_lefse" name="Make.lefse" version="@WRAPPER_VERSION@.0">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
2 <description>create a lefse formatted input file from mothur's output files</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 'make.lefse(
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 #else
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 #end if
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
15 #if $design:
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
16 design=$design,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
17 #end if
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
18 #if $constaxonomy:
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
19 constaxonomy=$constaxonomy,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
20 #end if
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
21 #if $label:
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
22 label=${ str($label).replace(",","-") },
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
23 #end if
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
24 scale=$scale
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 \${prefix%.dat}*.lefse "$lefse_out" &&
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
32 mv mothur.*.logfile "$logfile"
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 or relabund - provide a shared or relabund file"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
36 <param name="label" type="select" optional="true" label="label - OTU Labels" help="If none selected, the first label in your file will be used">
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="constaxonomy" type="data" format="mothur.cons.taxonomy" optional="true" label="constaxonomy - provide a constaxonomy file"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
40 <param name="design" type="data" format="tabular" optional="true" label="design - provide your design file"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
41 <param name="scale" type="select" multiple="false" label="scale - select what scale you would like to use to convert your shared file abundances to relative abundances" help="">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
42 <option value="totalgroup" selected="true">totalgroup</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
43 <option value="totalotu">totalotu</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
44 <option value="averagegroup">averagegroup</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
45 <option value="averageotu">averageotu</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
46 </param>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
47 </inputs>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
48 <outputs>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
49 <data name="logfile" format="txt" label="${tool.name} on ${on_string}: logfile"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
50 <data name="lefse_out" format="tabular" label="${tool.name} on ${on_string}: lefse"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
51 </outputs>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
52 <tests>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
53 <test><!-- test with shared file and defaults -->
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
54 <param name="otu" value="amazon.an.shared" ftype="mothur.shared"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
55 <output name="lefse_out" md5="295633107cd983be73389e8b92164686" ftype="tabular"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
56 <expand macro="logfile-test"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
57 </test>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
58 <test><!-- test with relabund file -->
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
59 <param name="otu" value="amazon.an.relabund" ftype="mothur.relabund"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
60 <param name="design" value="toymothur.design2" ftype="tabular"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
61 <param name="label" value="0.18"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
62 <output name="lefse_out" md5="c1e88702c6db198080c09f3b9c404c63" ftype="tabular"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
63 <expand macro="logfile-test"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
64 </test>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
65 </tests>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
66 <help>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
67 <![CDATA[
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
68
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
69 @MOTHUR_OVERVIEW@
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
70
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
71 **Command Documenation**
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
72
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
73 The make.lefse_ allows you to create a lefse formatted input file from mothur's output files.
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
74
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
75 .. _make.lefse: http://www.mothur.org/wiki/Make.lefse
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
76
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
77 ]]>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
78 </help>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
79 <citations>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
80 <citation type="doi">10.1128/AEM.01541-09</citation>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
81 </citations>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
82 </tool>