annotate tools/mothur/dist.seqs.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_dist_seqs" name="Dist.seqs" version="@WRAPPER_VERSION@.0">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
2 <description>calculate uncorrected pairwise distances between aligned sequences</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 'dist.seqs(
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
10 fasta=$fasta,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
11 #if $calc:
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
12 calc=$calc,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
13 #end if
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
14 countends=$countends,
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
15 #if $cutoff:
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 #end if
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
18 #if $output:
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
19 output=$output,
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 processors='\${GALAXY_SLOTS:-8}'
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
22 )'
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
23 | sed 's/ //g' ## mothur trips over whitespace
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
24 | mothur &&
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
25
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
26 ## move output files to correct destination
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
27 prefix="$fasta" &&
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
28 mv \${prefix%.dat}*.dist "$out_dist" &&
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
29 mv mothur.*.logfile "$logfile"
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
30 ]]></command>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
31 <inputs>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
32 <param name="fasta" type="data" format="mothur.align" label="fasta - Alignment Fasta"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
33 <param name="calc" type="select" label="calc - Calc Method - Gap Penality">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
34 <option value="" selected="true">use default</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
35 <option value="onegap">onegap - counts a string of gaps as a single gap</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
36 <option value="nogaps">nogaps - ignores gaps</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
37 <option value="eachgap ">eachgap - penalize each gap</option>
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="countends" type="boolean" checked="true" truevalue="true" falsevalue="false" label="countends - Penalize terminal gaps"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
40 <param name="cutoff" type="float" value="" min="0.0" optional="true" label="cutoff - Distance Cutoff threshold - ignored if not > 0" help="Do not save any distances larger than this, a common value would be 0.10"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
41 <param name="output" type="select" label="output - Distance Matrix Output Format" help="">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
42 <option value="" selected="true">Default Column-Formatted Matrix</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
43 <option value="lt">Phylip formatted Lower Triangle Matrix</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
44 <option value="square">Phylip formatted Square Matrix</option>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
45 </param>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
46 </inputs>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
47 <outputs>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
48 <data name="logfile" format="txt" label="${tool.name} on ${on_string}: logfile"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
49 <data name="out_dist" format="mothur.pair.dist" label="${tool.name} on ${on_string}: dist">
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
50 <change_format>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
51 <when input="output" value="lt" format="mothur.lower.dist"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
52 <when input="output" value="square" format="mothur.square.dist"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
53 </change_format>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
54 </data>
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 with default params -->
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
58 <param name="fasta" value="HMP_MOCK.v35.align" ftype="mothur.align"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
59 <output name="out_dist" md5="2c4817bb8657b4df2dcb1f2a019f505e" ftype="mothur.pair.dist"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
60 <expand macro="logfile-test"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
61 </test>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
62 <test><!-- test with all params custom -->
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
63 <param name="fasta" value="HMP_MOCK.v35.align" ftype="mothur.align"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
64 <param name="calc" value="nogaps"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
65 <param name="countends" value="false"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
66 <param name="cutoff" value="0.3"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
67 <param name="output" value="lt"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
68 <output name="out_dist" md5="8a5ccf1ad8f1c344cf4d3e2c97d4cdc6" ftype="mothur.lower.dist"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
69 <expand macro="logfile-test"/>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
70 </test>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
71 </tests>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
72 <help>
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
73 <![CDATA[
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
74
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
75 @MOTHUR_OVERVIEW@
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
76
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
77 **Command Documenation**
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
78
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
79 The dist.seqs_ command will calculate uncorrected pairwise distances between aligned sequences. The command will generate a column-formatted_distance_matrix_ that is compatible with the column option in the read.dist command. The command is also able to generate a phylip-formatted_distance_matrix_. There are several options for how to handle gap comparisons and terminal gaps.
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
80
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
81 .. _column-formatted_distance_matrix: http://www.mothur.org/wiki/Column-formatted_distance_matrix
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
82 .. _phylip-formatted_distance_matrix: http://www.mothur.org/wiki/Phylip-formatted_distance_matrix
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
83 .. _dist.seqs: http://www.mothur.org/wiki/Dist.seqs
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
84
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
85 v.1.20.0: Updated to Mothur 1.33
ee4fee239fe7 planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty
sanbi-uwc
parents:
diff changeset
86
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>