annotate tools/mothur/shhh.flows.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_shhh_flows" name="Shhh.flows" version="@WRAPPER_VERSION@.0">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
2 <description>Denoise flowgrams (PyroNoise algorithm)</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 ## Mothur can't handle scientific notation (i.e. 1e-6)
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
10 #set mindelta_decimal = "{:.12f}".format(float($mindelta))
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
11 echo 'shhh.flows(
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
12 flow=$flow,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
13 lookup=$prob.lookup,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
14 maxiter=$maxiter,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
15 mindelta=$mindelta_decimal,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
16 cutoff=$cutoff,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
17 sigma=$sigma,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
18 order=$order,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
19 large=$large,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
20 processors='\${GALAXY_SLOTS:-8}'
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
21 )'
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
22 | sed 's/ //g' ## mothur trips over whitespace
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
23 | mothur &&
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
24
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
25 ## move output files to correct destination
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
26 prefix="$flow" &&
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
27 mv \${prefix%.dat}*.qual "$shhh_qual" &&
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
28 mv \${prefix%.dat}*.fasta "$shhh_fasta" &&
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
29 mv \${prefix%.dat}*.names "$shhh_names" &&
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
30 mv \${prefix%.dat}*.counts "$shhh_counts" &&
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
31 mv \${prefix%.dat}*.groups "$shhh_groups" &&
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="flow" type="data" format="mothur.sff.flow" label="flow - flowgram data" help="Use sffinfo to generate flow data from an sff file and usually trimmed by trim.flows"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
36 <conditional name="prob">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
37 <param name="source" type="select" label="Select Taxonomy from" help="">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
38 <option value="ref">Cached Reference</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
39 <option value="hist">History</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
40 </param>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
41 <when value="ref">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
42 <param name="lookup" type="select" format="tabular" label="lookup - intensity value per homopolymer length" help="table of the probability of observing an intensity value for a given homopolymer length">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
43 <options from_data_table="mothur_lookup"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
44 </param>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
45 </when>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
46 <when value="hist">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
47 <param name="lookup" type="data" format="tabular" label="lookup - intensity value per homopolymer length" help="from http://www.mothur.org/wiki/Lookup_files"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
48 </when>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
49 </conditional>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
50 <param name="maxiter" type="integer" value="1000" min="10" label="maxiter - maximum iterations to run (default 1000)" help="if the delta value does not first drop below the mindelta value. "/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
51 <param name="mindelta" type="float" value="0.000001" min="0.0" max="0.1" label="mindelta - threshold for determining how much change in the flowgram correction is allowed" help="default .000001 (10^-6)"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
52 <param name="cutoff" type="float" value="0.01" min="0.0" max="1.0" label="cutoff - seed the expectation-maximizaton step" help="default .01 (usually doesn't need to be changed)"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
53 <param name="sigma" type="float" value="0.06" min="0.0" max="1.0" label="sigma - the dispersion of the data in the expectation-maximization step of the algorithm" help="default .06 (usually doesn't need to be changed)"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
54 <param name="large" type="integer" value="10000" min="1" label="large - split your flow file and process the pieces separately (default 10000)" help=""/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
55 <param name="order" type="text" value="A" label="order - flow order for nucleotides in the sequencer" help="default is A, was TACG. Also accepts B or I"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
56 </inputs>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
57 <outputs>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
58 <data name="logfile" format="txt" label="${tool.name} on ${on_string}: logfile"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
59 <data name="shhh_fasta" format="fasta" label="${tool.name} on ${on_string}: shhh.fasta"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
60 <data name="shhh_qual" format="qual454" label="${tool.name} on ${on_string}: shhh.qual"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
61 <data name="shhh_names" format="mothur.names" label="${tool.name} on ${on_string}: shhh.names"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
62 <data name="shhh_groups" format="mothur.groups" label="${tool.name} on ${on_string}: shhh.groups"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
63 <data name="shhh_counts" format="tabular" label="${tool.name} on ${on_string}: shhh.counts"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
64 </outputs>
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 <test>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
67 <param name="flow" value="mock.flow" ftype="mothur.sff.flow"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
68 <param name="source" value="hist"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
69 <param name="lookup" value="LookUp_Titanium.pat"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
70 <output name="shhh_fasta" md5="dae330939c01e4831e2f804adc90493c" ftype="fasta"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
71 <output name="shhh_qual" md5="47e8c7d953f276277d40375b2fb0feec" ftype="qual454"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
72 <output name="shhh_names" md5="98326572926c744f4a1ea342ff7c7dcc" ftype="mothur.names"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
73 <output name="shhh_groups" md5="e7f4237cef054ddf52a63ebad568a350" ftype="mothur.groups"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
74 <output name="shhh_counts" md5="ae26201637dc3a64e6865c43c317a688" ftype="tabular"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
75 <expand macro="logfile-test"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
76 </test>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
77 </tests>
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 <![CDATA[
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
80
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
81 @MOTHUR_OVERVIEW@
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
82
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
83 **Command Documenation**
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
84
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
85 The shhh.flows_ command is Pat Schloss's translation of Chris Quince's PyroNoise algorithm [1] from C to C++ with the incorporation of mothur's bells and whistles. Based on processing of test datasets provided by Quince, shhh.flows gives the same/similar output to AmpliconNoise. shhh.flows uses a expectation-maximization algorithm to correct flowgrams to identify the idealized form of each flowgram and translate that flowgram to a DNA sequence. Our testing has shown that when Titanium data are trimmed to 450 flows using trim.flows, shhh.flows provides the highest quality data for any other method available. In contrast, when we use the min/max number of flows suggested by Quince of 360/720, the error rate is not that great. This much improved error rate does come at a computational cost. Whereas the features in trim.seqs take on the order of minutes, shhh.flows can take on the order of hours. You will also need a lookup file that tells shhh.flows the probability of observing an intensity value for a given homopolymer length. You can get mothur-compatible files at: http://www.mothur.org/wiki/Lookup_files
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
86
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
87 .. _shhh.flows: http://www.mothur.org/wiki/Shhh.flows
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
88
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
89 ]]>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
90 </help>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
91 <expand macro="citations"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
92 </tool>