annotate MUMmer/mummer_maxmatch.xml @ 2:479eb076cd23

Add revised mummer toolshed files to testtoolshed
author abossers
date Tue, 28 Oct 2014 16:59:33 +0100
parents
children f807110e7c80
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
1 <tool id="mummer_maxmatch" name="MUMmer MaxMatch" version="0.9.alx" force_history_refresh="True">
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
2 <description>: Maximal exact sequence matching</description>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
3 <command>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
4 <!-- update this path to the installed location -->
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
5 $tool.cmd
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
6 #if $tool.cmd=="mummer":
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
7 $tool.cmd_extra
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
8 $tool.mum_ref_in
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
9 $tool.mum_q_in
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
10 #end if
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
11 #if $tool.cmd=="repeat-match":
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
12 -n $tool.rm_n
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
13 #if $tool.rm_E=="yes":
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
14 -E
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
15 #end if
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
16 $tool.cmd_extra
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
17 $tool.in_seq
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
18 #end if
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
19 #if $tool.cmd=="exact-tandems":
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
20 $tool.in_seq
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
21 $tool.et_minl
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
22 #end if
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
23 <!-- unfortunate somehow error state gets set also on succesfull jobs. Pipe io stderr to dev/null -->
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
24 2&gt;&amp;-
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
25 > $out_tool
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
26
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
27 </command>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
28 <inputs>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
29 <conditional name="tool">
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
30 <param name="cmd" type="select" value="mummer" label="MUMmer maximal matching" help="Algorithms are run with default parameters (none). For specific args see help below" >
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
31 <option value="mummer">mummer</option>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
32 <option value="repeat-match">repeat-match</option>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
33 <option value="exact-tandems">exact-tandems</option>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
34 </param>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
35 <when value="mummer">
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
36 <param name="mum_ref_in" type="data" format="fasta" label="Reference FastA file" />
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
37 <param name="mum_q_in" type="data" format="fasta" label="Query (multi) FastA sequence" />
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
38 <param name="cmd_extra" type="text" size="40" value="" label="Extra cmd line options" help="See specific cmd line options below for each tool" />
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
39 </when>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
40 <when value="repeat-match">
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
41 <param name="in_seq" type="data" format="fasta" label="FastA sequence file" />
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
42 <param name="rm_n" type="text" size="5" value="20" label="Minimum exact match length [-n]" />
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
43 <param name="rm_E" type="select" value="no" label="Use exhaustive (slow) search to find matches [-E]" >
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
44 <option value="no">No</option>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
45 <option value="yes">Yes</option>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
46 </param>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
47 <param name="cmd_extra" type="text" size="40" value="" label="Extra cmd line options" help="-n and -E are configured above. More specific cmd line options in help below." />
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
48 </when>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
49 <when value="exact-tandems">
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
50 <param name="in_seq" type="data" format="fasta" label="FastA sequence file" />
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
51 <param name="et_minl" type="text" size="5" value="20" label="Minimum length" />
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
52 </when>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
53 </conditional>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
54 </inputs>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
55 <outputs>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
56 <data name="out_tool" format="text" label="Max exact match output" />
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
57 </outputs>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
58 <requirements>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
59 <!-- <requirement type="set_environment" version="3.23">MUMMER_PATH</requirement> -->
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
60 <requirement type="package" version="4.6.4">gnuplot</requirement>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
61 <requirement type="package" version="3.23">MUMmer</requirement>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
62 </requirements>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
63 <tests>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
64 <test>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
65 </test>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
66 </tests>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
67 <help>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
68 |
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
69
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
70
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
71 **Reference**
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
72 =============
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
73
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
74 - **MUMmer MaxExactMatch Galaxy tool wrapper:** Alex Bossers, CVI of Wageningen UR, The Netherlands.
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
75
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
76 - **MUMmer suite v3.22:** http://mummer.sourceforge.net
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
77
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
78 - **MUMmer tutorials:** http://mummer.sourceforge.net/examples/
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
79
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
80 Please do not use any of the command line options that modify prefixes or file names. As obvious
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
81 they are quite useless within galaxy and are likely to fail the routine!
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
82
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
83 If you found these tools/wrappers usefull in your research, please acknowledge our work. If you improve
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
84 or modify the wrappers please add instead of substitute yourself into the acknowlegement section :)
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
85
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
86
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
87
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
88 **MUMmer Maximal exact matching**
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
89 =================================
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
90
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
91 The heart of the MUMmer package is its suffix tree based maximal matching routines. These can be
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
92 used for repeat detection within a single sequence as is done by *repeat-match* and *exact-tandems*,
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
93 or can be used for the alignment of two or more sequences as is done by *mummer*.
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
94
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
95 Mummer
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
96 ------
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
97
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
98 mummer is a suffix tree algorithm designed to find maximal exact matches of some minimum length
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
99 between two input sequences. by default mummer will only find maximal matches that are unique in
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
100 the entire set of reference sequences. The match lists produced by mummer can be used alone to
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
101 generate alignment dot plots, or can be passed on to the clustering algorithms for the identification
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
102 of longer non-exact regions of conservation. These match lists have great versatility because they
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
103 contain huge amounts of information and can be passed forward to other interpretation programs for
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
104 clustering, analysis, searching, etc.
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
105
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
106
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
107 Repeat-match
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
108 ------------
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
109
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
110 repeat-match is a suffix tree algorithm designed to find maximal exact repeats within a single input
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
111 sequence. It uses a similar algorithm to mummer, but altered slightly to find maximal exact matches
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
112 within a single sequence.
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
113
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
114 Output formatting varies depending on the command line parameters and the output can be quite large.
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
115 The standard output format that results from running repeat-match with default parameters is as follows:
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
116 ::
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
117
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
118 Long Exact Matches:
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
119 Start1 Start2 Length
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
120 4919485 4919506r 22
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
121
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
122 The three columns are the first position of the repeat, the second position of the repeat, and the
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
123 length of the repeat respectively. Reverse complement repeat positions are denoted by an 'r'
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
124 following the Start2 position, and are relative to the forward strand of the sequence.
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
125
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
126
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
127 Exact-tandems
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
128 -------------
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
129
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
130 exact-tandems is a wrapper script for the repeat-match program. It provides a list of exact tandem
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
131 repeats within a single input sequence. As with repeat-match the sequence file should contain only
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
132 one sequence in FastA format, however if multiple sequences exist the first one will be used. The
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
133 sequence may contain any set of upper and lowercase characters, thus DNA and protein sequence are
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
134 both allowed and matching is case insensitive. The minimum match length parameter should be a
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
135 positive integer, this value will be passed to the repeat-match program via the -n option.
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
136
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
137 The output format of exact-tandems is as follows:
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
138 ::
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
139
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
140 Finding matches
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
141 Tandem repeats
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
142 Start Extent UnitLen Copies
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
143 416173 150 45 3.3
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
144
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
145 The four columns are the first position of the tandem, the extent of the repeat region, the length
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
146 of each tandem repeat unit, and the number of repeat units respectively.
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
147
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
148
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
149
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
150 **Manuals and CMD line options (specific for each tool!):**
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
151 ===========================================================
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
152
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
153 **Mummer**
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
154
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
155 http://mummer.sourceforge.net/manual/#mummer
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
156
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
157 **Repeat-match**
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
158
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
159 http://mummer.sourceforge.net/manual/#repeat
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
160
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
161 **exact-tandems**
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
162
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
163 http://mummer.sourceforge.net/manual/#exact
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
164
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
165 |
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
166 |
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
167
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
168 </help>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
169 </tool>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
170