Mercurial > repos > devteam > velvet

comparison velvetg.xml @ 0:08256557922f draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 4720b3dfa114d790b597fef6ccf3c17e8c11e111
author devteam
date Tue, 13 Oct 2015 16:38:28 -0400
parents
children 5da9a0e2fb2d
comparison
equal deleted inserted replaced
-1:000000000000 0:08256557922f
1 <tool id="velvetg" name="velvetg" version="@WRAPPER_VERSION@.0">
2 <description>Velvet sequence assembler for very short reads</description>
3 <version_command>velvetg 2&gt;&amp;1 | grep "Version" | sed -e 's/Version //'</version_command>
4 <macros>
5 <import>macros.xml</import>
6 </macros>
7 <expand macro="requirements"/>
8 <expand macro="stdio"/>
9 <command interpreter="python">
10 velvetg_wrapper.py
11 '$input.extra_files_path'
12 #if $generate_amos.afg == "yes":
13 -amos_file $generate_amos.afg
14 #end if
15 #if $unused_reads.generate_unused == "yes":
16 -unused_reads $unused_reads.generate_unused
17 #end if
18 $read_trkg
19 #if $coverage.cutoff == "auto":
20 -cov_cutoff auto
21 #elif $coverage.cutoff == "value":
22 -cov_cutoff $coverage.cov_cutoff
23 #end if
24 #if $expected.coverage == "auto":
25 -exp_cov auto
26 #elif $expected.coverage == "value":
27 -exp_cov $expected.exp_cov
28 #end if
29 #if $contig_lgth.use_contig_lgth == "yes":
30 -min_contig_lgth $contig_lgth.min_contig_lgth
31 #end if
32 #if $reads.paired == "yes":
33 #if int($reads.ins_length) > 0:
34 -ins_length $reads.ins_length
35 #end if
36 #if $reads.options.advanced == "yes":
37 #if int($reads.options.ins_length_sd) > 0:
38 -ins_length_sd $reads.options.ins_length_sd
39 #end if
40 #if int($reads.options.ins_length2) > 0:
41 -ins_length2 $reads.options.ins_length2
42 #end if
43 #if int($reads.options.ins_length2_sd) > 0:
44 -ins_length2_sd $reads.options.ins_length2_sd
45 #end if
46 #if int($reads.options.ins_length_long) > 0:
47 -ins_length_long $reads.options.ins_length_long
48 #end if
49 #if int($reads.options.ins_length_long_sd) > 0:
50 -ins_length_long_sd $reads.options.ins_length_long_sd
51 #end if
52 #if int($reads.options.max_branch_length) > 0:
53 -max_branch_length $reads.options.max_branch_length
54 #end if
55 #if int($reads.options.max_divergence) > 0:
56 -max_divergence $reads.options.max_divergence
57 #end if
58 #if int($reads.options.max_gap_count) > 0:
59 -max_gap_count $reads.options.max_gap_count
60 #end if
61 #if int($reads.options.min_pair_count) > 0:
62 -min_pair_count $reads.options.min_pair_count
63 #end if
64 #if int($reads.options.max_coverage) > 0:
65 -max_coverage $reads.options.max_coverage
66 #end if
67 #if int($reads.options.long_mult_cutoff) > 0:
68 -long_mult_cutoff $reads.options.long_mult_cutoff
69 #end if
70 $reads.options.scaffolding
71 #end if
72 #end if
73 </command>
74 <inputs>
75 <param name="input" type="data" format="velvet" label="Velvet Dataset" help="Prepared by velveth."/>
76 <conditional name="generate_amos">
77 <param name="afg" type="select" label="Generate a AMOS.afg file">
78 <option value="no">No</option>
79 <option value="yes">Yes</option>
80 </param>
81 <when value="no"/>
82 <when value="yes"/>
83 </conditional>
84
85 <conditional name="unused_reads">
86 <param name="generate_unused" type="select" label="Generate a UnusedReads fasta file">
87 <option value="no">No</option>
88 <option value="yes">Yes</option>
89 </param>
90 <when value="no"/>
91 <when value="yes"/>
92 </conditional>
93
94 <conditional name="last_graph">
95 <param name="generate_graph" type="select" label="Generate velvet LastGraph file">
96 <option value="no">No</option>
97 <option value="yes">Yes</option>
98 </param>
99 <when value="no"/>
100 <when value="yes"/>
101 </conditional>
102
103 <param name="read_trkg" type="boolean" checked="false" truevalue="-read_trkg yes" falsevalue="-read_trkg no" label="Tracking of short read positions in assembly" help="Generates Graph2 dataset" />
104
105 <conditional name="coverage">
106 <param name="cutoff" type="select" label="Coverage cutoff" help="">
107 <option value="none">None</option>
108 <option value="auto">Automatically Determined</option>
109 <option value="value">Specify Cutoff Value</option>
110 </param>
111 <when value="none"/>
112 <when value="auto"/>
113 <when value="value">
114 <param name="cov_cutoff" value="10.0" label="Remove nodes with coverage below" type="float" />
115 </when>
116 </conditional>
117
118 <conditional name="expected">
119 <param name="coverage" type="select" label="Expected Coverage of Unique Regions" help="">
120 <option value="none">None</option>
121 <option value="auto">Automatically Determined</option>
122 <option value="value">Specify Expected Value</option>
123 </param>
124 <when value="none"/>
125 <when value="auto"/>
126 <when value="value">
127 <param name="exp_cov" value="10.0" label="Remove nodes with coverage below" type="float" />
128 </when>
129 </conditional>
130
131 <conditional name="contig_lgth">
132 <param name="use_contig_lgth" type="select" label=" Set minimum contig length" help="minimum contig length exported to contigs.fa file (default: hash length * 2).">
133 <option value="no">No</option>
134 <option value="yes">Yes</option>
135 </param>
136 <when value="no"/>
137 <when value="yes">
138 <param name="min_contig_lgth" value="42" label="minimum contig length" type="integer" help="minimum contig length exported to contigs.fa file (default: hash length * 2)"/>
139 </when>
140 </conditional>
141
142 <conditional name="reads">
143 <param name="paired" type="select" label="Using Paired Reads">
144 <option value="no">No</option>
145 <option value="yes" selected="${input.metadata.paired_end_reads}">Yes</option>
146 </param>
147 <when value="no"/>
148 <when value="yes">
149 <param name="ins_length" value="-1" label="Insert Length in Paired-End Read dataset (ignored when -1)" type="integer" help="Expected distance between two paired end reads"/>
150 <conditional name="options">
151 <param name="advanced" type="select" label="Velvet Advanced Options">
152 <option value="no">Use Defaults</option>
153 <option value="yes">Set Advanced Option Values</option>
154 </param>
155 <when value="no"/>
156 <when value="yes">
157 <param name="ins_length_sd" value="-1" label="Estimate of Standard Deviation of Paired-End Read dataset(ignored when -1)" type="integer" help="Estimate of standard deviation of Paired-End Read dataset (default: 10% of corresponding length)"/>
158 <param name="ins_length2" value="-1" label="Insert Length in 2nd Paired-End Short Read dataset (ignored when -1)" type="integer" help="Expected distance between two paired end reads in the second short-read dataset"/>
159 <param name="ins_length2_sd" value="-1" label="Estimate of Standard Deviation of 2nd Paired-End Read dataset (ignored when -1)" type="integer" help="Estimate of standard deviation of 2nd Paired-End Read dataset (default: 10% of corresponding length)"/>
160 <param name="ins_length_long" value="-1" label="Insert Length in Long Paired-End Read dataset (ignored when -1)" type="integer" help="Expected distance between two long paired-end reads"/>
161 <param name="ins_length_long_sd" value="-1" label="Estimate of Standard Deviation of 2nd Paired-End Read dataset (ignored when -1)" type="integer" help="Estimate of standard deviation of Long Paired-End Read dataset (default: 10% of corresponding length)"/>
162 <param name="max_branch_length" value="-1" label="Maximum branch length (ignored when -1)" type="integer" help="maximum length in base pair of bubble (default: 100)"/>
163 <param name="max_divergence" value="-1." label="Maximum max_divergence (between .0 and 1., ignored when -1.)" type="float" help="maximum divergence rate between two branches in a bubble (default: .2)"/>
164 <param name="max_gap_count" value="-1" label="Maximum gap count (ignored when -1)" type="integer" help="maximum number of gaps allowed in the alignment of the two branches of a bubble (default: 3)"/>
165 <param name="min_pair_count" value="-1" label="Minimum read-pair count (ignored when -1)" type="integer" help="minimum number of paired end connections to justify the scaffolding of two long contigs (default: 10)"/>
166 <param name="max_coverage" value="-1." label="Maximum coverage exclusion(ignored when -1.)" type="float" help="Exclude data that has coverage more than this maximum coverage value"/>
167 <param name="long_mult_cutoff" value="-1" label="Minimum number of long reads required to merge contigs (ignored when -1)" type="integer" help="minimum number of long reads required to merge contigs (default: 2)"/>
168 <param name="scaffolding" type="boolean" checked="true" truevalue="-scaffolding yes" falsevalue="-scaffolding no" label="Use Scaffolding" help="Scaffold contigs that it cannot quite be connected (This results in sequences of Ns in the contigs)"/>
169
170 </when>
171 </conditional>
172 </when>
173 </conditional>
174 </inputs>
175 <outputs>
176 <data format="txt" name="Graph2" label="${tool.name} on ${on_string}: Graph2" from_work_dir="Graph2">
177 <filter>read_trkg is True</filter>
178 </data>
179 <data format="txt" name="LastGraph" label="${tool.name} on ${on_string}: LastGraph" from_work_dir="LastGraph">
180 <filter>last_graph['generate_graph'] == "yes"</filter>
181 </data>
182 <data format="afg" name="velvet_asm" label="${tool.name} on ${on_string}: AMOS.afg" from_work_dir="velvet_asm.afg">
183 <filter>generate_amos['afg'] == "yes"</filter>
184 </data>
185 <data format="fasta" name="unused_reads_fasta" label="${tool.name} on ${on_string}: Unused Reads" from_work_dir="UnusedReads.fa">
186 <filter>unused_reads['generate_unused'] == "yes"</filter>
187 </data>
188 <data format="tabular" name="stats" label="${tool.name} on ${on_string}: Stats" from_work_dir="stats.txt" />
189 <data format="fasta" name="contigs" label="${tool.name} on ${on_string}: Contigs" from_work_dir="contigs.fa" />
190 </outputs>
191 <requirements>
192 <requirement type="package">velvet</requirement>
193 </requirements>
194 <tests>
195 <test>
196 <param name="input" value="velveth_test1/output.html" ftype="velvet" >
197 <composite_data value='velveth_test1/Sequences' ftype="Sequences"/>
198 <composite_data value='velveth_test1/Roadmaps' ftype="Roadmaps"/>
199 <composite_data value='velveth_test1/Log'/>
200 </param>
201 <param name="afg" value="yes" />
202 <param name="generate_unused" value="yes" />
203 <param name="generate_graph" value="no" />
204 <param name="read_trkg" value="-read_trkg no" />
205 <param name="cutoff" value="auto" />
206 <param name="coverage" value="auto" />
207 <param name="use_contig_lgth" value="no" />
208 <param name="paired" value="no" />
209 <!--
210 <output name="LastGraph" file="velvetg_test1/lastgraph.txt" compare="diff"/>
211 -->
212 <output name="velvet_asm" file="velvetg_test1/amos.afg" compare="diff"/>
213 <output name="unused_reads_fasta" file="velvetg_test1/unusedreads.fa" compare="diff"/>
214 <output name="stats" file="velvetg_test1/stats.csv" compare="diff"/>
215 <output name="contigs" file="velvetg_test1/contigs.fa" compare="diff"/>
216 </test>
217 </tests>
218 <help>
219 **What it does**
220
221 Velvet_ is a de novo genomic assembler specially designed for short read sequencing technologies, such as Solexa or 454, developed by Daniel Zerbino and Ewan Birney at the European Bioinformatics Institute (EMBL-EBI), near Cambridge, in the United Kingdom.
222
223 Velvet currently takes in short read sequences, removes errors then produces high quality unique contigs. It then uses paired-end read and long read information, when available, to retrieve the repeated areas between contigs.
224
225 Read the Velvet `documentation`__ for details on using the Velvet Assembler.
226
227 .. _Velvet: http://www.ebi.ac.uk/~zerbino/velvet/
228
229 .. __: http://www.ebi.ac.uk/~zerbino/velvet/Manual.pdf
230
231 ------
232
233 **Input formats**
234
235 Velvet can input sequence files in the following formats: fasta fastq fasta.gz fastq.gz eland gerald
236
237 The input files are prepared for the velvet assembler using **velveth**.
238
239 ------
240
241 **Outputs**
242
243 **Contigs**
244
245 The *contigs.fa* file.
246 This fasta file contains the sequences of the contigs longer than 2k, where k is the word-length used in velveth. If you have specified a min contig length threshold, then the contigs shorter than that value are omitted.
247 Note that the length and coverage information provided in the header of each contig should therefore be understood in k-mers and in k-mer coverage (cf. 5.1) respectively.
248 The N's in the sequence correspond to gaps between scaffolded contigs. The number of N's corresponds to the estimated length of the gap. For reasons of compatibility with the archives, any gap shorter than 10bp is represented by a sequence of 10 N's.
249
250 **Stats**
251
252 The *stats.txt* file.
253 This file is a simple tabbed-delimited description of the nodes. The column names are pretty much self-explanatory. Note however that node lengths are given in k-mers. To obtain the length in nucleotides of each node you simply need to add k - 1, where k is the word-length used in velveth.
254 The in and out columns correspond to the number of arcs on the 5' and 3' ends of the contig respectively.
255 The coverages in columns short1 cov, short1 Ocov, short2 cov, and short2 Ocov are provided in k-mer coverage (5.1).
256 Also, the difference between # cov and # Ocov is the way these values are computed. In the first count, slightly divergent sequences are added to the coverage tally. However, in the second, stricter count, only the sequences which map perfectly onto the consensus sequence are taken into account.
257
258 **LastGraph**
259
260 The *LastGraph* file.
261 This file describes in its entirety the graph produced by Velvet.
262
263 **AMOS.afg**
264
265 The *velvet_asm.afg* file.
266 This file is mainly designed to be read by the open-source AMOS genome assembly package. Nonetheless, a number of programs are available to transform this kind of file into other assembly file formats (namely ACE, TIGR, Arachne and Celera). See http://amos.sourceforge.net/ for more information.
267 The file describes all the contigs contained in the contigs.fa file (cf 4.2.1).
268
269 ------
270
271 **Velvet parameter list**
272
273 This is a list of implemented Velvetg options::
274
275 Standard options:
276 -cov_cutoff floating-point|auto : removal of low coverage nodes AFTER tour bus or allow the system to infer it
277 (default: no removal)
278 -ins_length integer : expected distance between two paired end reads (default: no read pairing)
279 -read_trkg yes|no : tracking of short read positions in assembly (default: no tracking)
280 -min_contig_lgth integer : minimum contig length exported to contigs.fa file (default: hash length * 2)
281 -amos_file yes|no : export assembly to AMOS file (default: no export)
282 -exp_cov floating point|auto : expected coverage of unique regions or allow the system to infer it
283 (default: no long or paired-end read resolution)
284
285 Advanced options:
286 -ins_length2 integer : expected distance between two paired-end reads in the second short-read dataset (default: no read pairing)
287 -ins_length_long integer : expected distance between two long paired-end reads (default: no read pairing)
288 -ins_length*_sd integer : est. standard deviation of respective dataset (default: 10% of corresponding length)
289 [replace '*' by nothing, '2' or '_long' as necessary]
290 -scaffolding yes|no : scaffolding of contigs used paired end information (default: on)
291 -max_branch_length integer : maximum length in base pair of bubble (default: 100)
292 -max_divergence floating-point : maximum divergence rate between two branches in a bubble (default: 0.2)
293 -max_gap_count integer : maximum number of gaps allowed in the alignment of the two branches of a bubble (default: 3)
294 -min_pair_count integer : minimum number of paired end connections to justify the scaffolding of two long contigs (default: 10)
295 -max_coverage floating point : removal of high coverage nodes AFTER tour bus (default: no removal)
296 -long_mult_cutoff int : minimum number of long reads required to merge contigs (default: 2)
297 -unused_reads yes|no : export unused reads in UnusedReads.fa file (default: no)
298
299 Output:
300 directory/contigs.fa : fasta file of contigs longer than twice hash length
301 directory/stats.txt : stats file (tab-spaced) useful for determining appropriate coverage cutoff
302 directory/LastGraph : special formatted file with all the information on the final graph
303 directory/velvet_asm.afg : (if requested) AMOS compatible assembly file
304
305 </help>
306 <expand macro="citation"/>
307 </tool>