annotate edena_ovl_wrapper.xml @ 0:60609a9cef3b draft

Uploaded
author crs4
date Mon, 09 Sep 2013 05:44:31 -0400
parents
children cd6cc6d76708
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
60609a9cef3b Uploaded
crs4
parents:
diff changeset
1 <tool id="edena_ovl_wrapper" name="Edena (overlapping)" version="0.2.2">
60609a9cef3b Uploaded
crs4
parents:
diff changeset
2 <description></description>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
3 <requirements>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
4 <requirement type="package" version="3.130110">edena</requirement>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
5 </requirements>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
6 <version_command>edena -v</version_command>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
7 <command interpreter="python">
60609a9cef3b Uploaded
crs4
parents:
diff changeset
8 edena_ovl_wrapper.py
60609a9cef3b Uploaded
crs4
parents:
diff changeset
9 \${EDENA_SITE_OPTIONS:---nThreads 2}
60609a9cef3b Uploaded
crs4
parents:
diff changeset
10 #if $input_selection.input == "unpaired_file"
60609a9cef3b Uploaded
crs4
parents:
diff changeset
11 #for $i, $unpaired_file in enumerate( $input_selection.unpaired_input ):
60609a9cef3b Uploaded
crs4
parents:
diff changeset
12 #if $i == 0
60609a9cef3b Uploaded
crs4
parents:
diff changeset
13 #echo "--unpaired_input="
60609a9cef3b Uploaded
crs4
parents:
diff changeset
14 #end if
60609a9cef3b Uploaded
crs4
parents:
diff changeset
15 #echo $unpaired_file.unpaired_file
60609a9cef3b Uploaded
crs4
parents:
diff changeset
16 #echo '+'
60609a9cef3b Uploaded
crs4
parents:
diff changeset
17 #end for
60609a9cef3b Uploaded
crs4
parents:
diff changeset
18 #elif $input_selection.input == "dr_pairs"
60609a9cef3b Uploaded
crs4
parents:
diff changeset
19 #for $i, $dr_pair_1 in enumerate( $input_selection.dr_pairs_input ):
60609a9cef3b Uploaded
crs4
parents:
diff changeset
20 #if $i == 0
60609a9cef3b Uploaded
crs4
parents:
diff changeset
21 #echo "--dr_pair_1="
60609a9cef3b Uploaded
crs4
parents:
diff changeset
22 #end if
60609a9cef3b Uploaded
crs4
parents:
diff changeset
23 #echo $dr_pair_1.dr_pair_1
60609a9cef3b Uploaded
crs4
parents:
diff changeset
24 #echo '+'
60609a9cef3b Uploaded
crs4
parents:
diff changeset
25 #end for
60609a9cef3b Uploaded
crs4
parents:
diff changeset
26 #echo ' '
60609a9cef3b Uploaded
crs4
parents:
diff changeset
27 #for $i, $dr_pair_2 in enumerate( $input_selection.dr_pairs_input ):
60609a9cef3b Uploaded
crs4
parents:
diff changeset
28 #if $i == 0
60609a9cef3b Uploaded
crs4
parents:
diff changeset
29 #echo "--dr_pair_2="
60609a9cef3b Uploaded
crs4
parents:
diff changeset
30 #end if
60609a9cef3b Uploaded
crs4
parents:
diff changeset
31 #echo $dr_pair_2.dr_pair_2
60609a9cef3b Uploaded
crs4
parents:
diff changeset
32 #echo '+'
60609a9cef3b Uploaded
crs4
parents:
diff changeset
33 #end for
60609a9cef3b Uploaded
crs4
parents:
diff changeset
34 #elif $input_selection.input == "rd_pairs"
60609a9cef3b Uploaded
crs4
parents:
diff changeset
35 #for $i, $rd_pair_1 in enumerate( $input_selection.rd_pairs_input ):
60609a9cef3b Uploaded
crs4
parents:
diff changeset
36 #if $i == 0
60609a9cef3b Uploaded
crs4
parents:
diff changeset
37 #echo "--rd_pair_1="
60609a9cef3b Uploaded
crs4
parents:
diff changeset
38 #end if
60609a9cef3b Uploaded
crs4
parents:
diff changeset
39 #echo $rd_pair_1.rd_pair_1
60609a9cef3b Uploaded
crs4
parents:
diff changeset
40 #echo '+'
60609a9cef3b Uploaded
crs4
parents:
diff changeset
41 #end for
60609a9cef3b Uploaded
crs4
parents:
diff changeset
42 #echo ' '
60609a9cef3b Uploaded
crs4
parents:
diff changeset
43 #for $i, $rd_pair_2 in enumerate( $input_selection.rd_pairs_input ):
60609a9cef3b Uploaded
crs4
parents:
diff changeset
44 #if $i == 0
60609a9cef3b Uploaded
crs4
parents:
diff changeset
45 #echo "--rd_pair_2="
60609a9cef3b Uploaded
crs4
parents:
diff changeset
46 #end if
60609a9cef3b Uploaded
crs4
parents:
diff changeset
47 #echo $rd_pair_2.rd_pair_2
60609a9cef3b Uploaded
crs4
parents:
diff changeset
48 #echo '+'
60609a9cef3b Uploaded
crs4
parents:
diff changeset
49 #end for
60609a9cef3b Uploaded
crs4
parents:
diff changeset
50 #end if
60609a9cef3b Uploaded
crs4
parents:
diff changeset
51 #if str($minOlap)
60609a9cef3b Uploaded
crs4
parents:
diff changeset
52 --minOlap=$minOlap
60609a9cef3b Uploaded
crs4
parents:
diff changeset
53 #end if
60609a9cef3b Uploaded
crs4
parents:
diff changeset
54 #if str($readsTruncation)
60609a9cef3b Uploaded
crs4
parents:
diff changeset
55 --readsTruncation=$readsTruncation
60609a9cef3b Uploaded
crs4
parents:
diff changeset
56 #end if
60609a9cef3b Uploaded
crs4
parents:
diff changeset
57 --output=$output
60609a9cef3b Uploaded
crs4
parents:
diff changeset
58 --logfile=$logfile
60609a9cef3b Uploaded
crs4
parents:
diff changeset
59 </command>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
60
60609a9cef3b Uploaded
crs4
parents:
diff changeset
61 <inputs>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
62 <conditional name="input_selection">
60609a9cef3b Uploaded
crs4
parents:
diff changeset
63 <param name="input" type="select" label="Select input type">
60609a9cef3b Uploaded
crs4
parents:
diff changeset
64 <option value="unpaired_file" selected="True">Unpaired files</option>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
65 <option value="dr_pairs">Direct-reverse paired-end files</option>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
66 <option value="rd_pairs">Reverse-direct paired-end files</option>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
67 </param>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
68
60609a9cef3b Uploaded
crs4
parents:
diff changeset
69 <when value="unpaired_file">
60609a9cef3b Uploaded
crs4
parents:
diff changeset
70 <repeat name="unpaired_input" title="Unpaired inputs (-r)" min="1">
60609a9cef3b Uploaded
crs4
parents:
diff changeset
71 <param name="unpaired_file" type="data" format="fasta,fastq" label="Unpaired file" help="FASTA or FASTQ format" />
60609a9cef3b Uploaded
crs4
parents:
diff changeset
72 </repeat>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
73 </when>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
74
60609a9cef3b Uploaded
crs4
parents:
diff changeset
75 <when value="dr_pairs">
60609a9cef3b Uploaded
crs4
parents:
diff changeset
76 <repeat name="dr_pairs_input" title="DR paired-end inputs (-DRpairs, -paired)" min="1">
60609a9cef3b Uploaded
crs4
parents:
diff changeset
77 <param name="dr_pair_1" type="data" format="fasta,fastq" label="DR paired-end file 1" help="FASTA or FASTQ format" />
60609a9cef3b Uploaded
crs4
parents:
diff changeset
78 <param name="dr_pair_2" type="data" format="fasta,fastq" label="DR paired-end file 2" help="FASTA or FASTQ format" />
60609a9cef3b Uploaded
crs4
parents:
diff changeset
79 </repeat>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
80 </when>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
81
60609a9cef3b Uploaded
crs4
parents:
diff changeset
82 <when value="rd_pairs">
60609a9cef3b Uploaded
crs4
parents:
diff changeset
83 <repeat name="rd_pairs_input" title="RD paired-end inputs (-RDpairs, -matePairs)" min="1">
60609a9cef3b Uploaded
crs4
parents:
diff changeset
84 <param name="rd_pair_1" type="data" format="fasta,fastq" label="RD paired-end file 1" help="FASTA or FASTQ format" />
60609a9cef3b Uploaded
crs4
parents:
diff changeset
85 <param name="rd_pair_2" type="data" format="fasta,fastq" label="RD paired-end file 2" help="FASTA or FASTQ format" />
60609a9cef3b Uploaded
crs4
parents:
diff changeset
86 </repeat>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
87 </when>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
88 </conditional>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
89
60609a9cef3b Uploaded
crs4
parents:
diff changeset
90 <param name="minOlap" type="integer" value="" optional="true" label="Minimum overlap size to compute (-M)" help="If not specified, this value is set to half of the reads length. When the sequencing coverage is sufficient, you can increase this value which will reduce the computational time. Edena will compute the overlaps whose sizes range from this value to the reads length." />
60609a9cef3b Uploaded
crs4
parents:
diff changeset
91
60609a9cef3b Uploaded
crs4
parents:
diff changeset
92 <param name="readsTruncation" type="integer" value="" optional="true" label="3' end reads truncation (-t)" help="Use this option to truncate the 3’end of the reads such that the resulting length is the inserted value. You may consider reads truncation since it can significantly improve the assembly. Since Edena computes exact overlaps, only error free reads can take part to the assembly. Since errors are likely to occur at the 3’ ends, shortening the reads by some nucleotides may increase the number of errors-free reads in the dataset, and thus increase the assembly performance." />
60609a9cef3b Uploaded
crs4
parents:
diff changeset
93
60609a9cef3b Uploaded
crs4
parents:
diff changeset
94 </inputs>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
95
60609a9cef3b Uploaded
crs4
parents:
diff changeset
96 <outputs>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
97 <data name="logfile" format="txt" label="${tool.name} on ${on_string}: log" />
60609a9cef3b Uploaded
crs4
parents:
diff changeset
98 <data name="output" format="ovl" label="${tool.name} on ${on_string}: overlapping" />
60609a9cef3b Uploaded
crs4
parents:
diff changeset
99 </outputs>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
100
60609a9cef3b Uploaded
crs4
parents:
diff changeset
101 <tests>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
102
60609a9cef3b Uploaded
crs4
parents:
diff changeset
103 </tests>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
104 <help>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
105 **What it does**
60609a9cef3b Uploaded
crs4
parents:
diff changeset
106
60609a9cef3b Uploaded
crs4
parents:
diff changeset
107 Edena can accept both unpaired and paired files, FASTQ and FASTA format. Note that for technical reasons, all reads are required to be of the same length. You can however provide the program with different files containing different reads length. In such case, Edena will trim the 3’ ends of the longer reads so that they fit the shorter length. It is however required that reads within each individual file are of the same length (as Illumina GA reads are). By default all overlaps with a minimum size corresponding to half of the reads length are computed. This is quite conservative. Provided enough coverage, this value can be increased (option -M) to reduce the memory requirements. For reads longer than 100bp, you may consider the reads truncation option, which could help in discarding 3’ base calling errors.
60609a9cef3b Uploaded
crs4
parents:
diff changeset
108
60609a9cef3b Uploaded
crs4
parents:
diff changeset
109 **License and citation**
60609a9cef3b Uploaded
crs4
parents:
diff changeset
110
60609a9cef3b Uploaded
crs4
parents:
diff changeset
111 This Galaxy tool is Copyright © 2013 `CRS4 Srl.`_ and is released under the `MIT license`_.
60609a9cef3b Uploaded
crs4
parents:
diff changeset
112
60609a9cef3b Uploaded
crs4
parents:
diff changeset
113 .. _CRS4 Srl.: http://www.crs4.it/
60609a9cef3b Uploaded
crs4
parents:
diff changeset
114 .. _MIT license: http://opensource.org/licenses/MIT
60609a9cef3b Uploaded
crs4
parents:
diff changeset
115
60609a9cef3b Uploaded
crs4
parents:
diff changeset
116 If you use this tool in Galaxy, please cite |Cuccuru2013|_.
60609a9cef3b Uploaded
crs4
parents:
diff changeset
117
60609a9cef3b Uploaded
crs4
parents:
diff changeset
118 .. |Cuccuru2013| replace:: Cuccuru, G., Orsini, M., Pinna, A., Sbardellati, A., Soranzo, N., Travaglione, A., Uva, P., Zanetti, G., Fotia, G. (2013) Orione, a web-based framework for NGS analysis in microbiology. *Submitted*
60609a9cef3b Uploaded
crs4
parents:
diff changeset
119 .. _Cuccuru2013: http://orione.crs4.it/
60609a9cef3b Uploaded
crs4
parents:
diff changeset
120
60609a9cef3b Uploaded
crs4
parents:
diff changeset
121 This tool uses `Edena`_, which is licensed separately. Please cite |Hernandez2008|_.
60609a9cef3b Uploaded
crs4
parents:
diff changeset
122
60609a9cef3b Uploaded
crs4
parents:
diff changeset
123 .. _Edena: http://www.genomic.ch/edena.php
60609a9cef3b Uploaded
crs4
parents:
diff changeset
124 .. |Hernandez2008| replace:: Hernandez, D., *et al.* (2008) De novo bacterial genome sequencing: Millions of very short reads assembled on a desktop computer. *Genome Res.* 18(5), 802-809
60609a9cef3b Uploaded
crs4
parents:
diff changeset
125 .. _Hernandez2008: http://genome.cshlp.org/content/18/5/802
60609a9cef3b Uploaded
crs4
parents:
diff changeset
126 </help>
60609a9cef3b Uploaded
crs4
parents:
diff changeset
127 </tool>