annotate sickle.xml @ 1:c522aaea6880

Uploaded
author nilesh
date Wed, 10 Jul 2013 00:15:08 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
1 <tool id="sickle" name="Sickle">
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
2 <description>Windowed Adaptive Trimming of FastQ data</description>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
3 <requirements>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
4 <requirement type="package" version="1.2.8">zlib</requirement>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
5 <requirement type="package" version="1.0.0">fastq_validator</requirement>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
6 </requirements>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
7 <command>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
8 /Users/amol/Desktop/galaxy-galaxy-dist-cea3ddf6cdda/tools/mytools/sickle $readtype.single_or_paired --quiet
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
9
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
10 #if str($readtype.single_or_paired) == "se":
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
11 -f $input_single -t $qual_type -o $output_single
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
12 #end if
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
13
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
14 #if str($readtype.single_or_paired) == "pe":
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
15 -f $input_paired1 -r $input_paired2 -o $output_paired1 -p $output_paired2 -s $output_paired_single -t $qual_type
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
16 #end if
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
17
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
18 #if str($qual_threshold) != "":
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
19 -q $qual_threshold
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
20 #end if
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
21
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
22 #if str($length_threshold) != "":
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
23 -l $length_threshold
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
24 #end if
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
25
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
26 #if $no_five_prime:
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
27 -x
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
28 #end if
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
29
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
30 #if $discard_n:
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
31 -n
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
32 #end if
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
33 </command>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
34
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
35 <inputs>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
36 <conditional name="readtype">
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
37 <param name="single_or_paired" type="select" optional="false" label="Single-End or Paired-End reads?">
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
38 <option value="se" selected="true">Single-End</option>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
39 <option value="pe">Paired-End</option>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
40 </param>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
41
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
42 <when value="se">
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
43 <param format="fastq, fastqsanger" name="input_single" type="data" optional="false" label="Single-End FastQ Reads"/>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
44 </when>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
45
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
46 <when value="pe">
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
47 <param format="fastq, fastqsanger" name="input_paired1" type="data" optional="false" label="Paired-End Forward Strand FastQ Reads"/>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
48 <param format="fastq, fastqsanger" name="input_paired2" type="data" optional="false" label="Paired-End Reverse Strand FastQ Reads"/>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
49 </when>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
50 </conditional>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
51
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
52 <param name="qual_type" type="select" optional="false" label="Quality type">
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
53 <option value="illumina" selected="true">Illumina</option>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
54 <option value="solexa">Solexa</option>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
55 <option value="sanger">Sanger</option>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
56 </param>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
57
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
58 <param name="qual_threshold" value="20" type="integer" optional="true" label="Quality Threshold">
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
59 <validator type="in_range" min="0" message="Minimum value is 0"/>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
60 </param>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
61
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
62 <param name="length_threshold" value="20" type="integer" optional="true" label="Length Threshold">
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
63 <validator type="in_range" min="0" message="Minimum value is 0"/>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
64 </param>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
65
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
66 <param name="no_five_prime" type="boolean" label="Don't do 5' trimming"/>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
67 <param name="discard_n" type="boolean" label="Discard sequences with Ns"/>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
68 </inputs>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
69
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
70 <outputs>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
71 <data format_source="input_single" name="output_single" label="Single-End output of ${tool.name} on ${on_string}">
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
72 <filter>(readtype['single_or_paired'] == 'se')</filter>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
73 </data>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
74
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
75 <data format_source="input_paired1" name="output_paired1" label="Paired-End forward strand output of ${tool.name} on ${on_string}">
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
76 <filter>(readtype['single_or_paired'] == 'pe')</filter>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
77 </data>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
78
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
79 <data format_source="input_paired2" name="output_paired2" label="Paired-End reverse strand output of ${tool.name} on ${on_string}">
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
80 <filter>(readtype['single_or_paired'] == 'pe')</filter>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
81 </data>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
82
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
83 <data format_source="input_paired1" name="output_paired_single" label="Singletons from Paired-End output of ${tool.name} on ${on_string}">
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
84 <filter>(readtype['single_or_paired'] == 'pe')</filter>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
85 </data>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
86 </outputs>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
87
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
88 <help>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
89 Most modern sequencing technologies produce reads that have deteriorating quality towards the 3'-end and some towards the 5'-end as well. Incorrectly called bases in both regions negatively impact assembles, mapping, and downstream bioinformatics analyses.
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
90
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
91 Sickle is a tool that uses sliding windows along with quality and length thresholds to determine when quality is sufficiently low to trim the 3'-end of reads and also determines when the quality is sufficiently high enough to trim the 5'-end of reads. It will also discard reads based upon the length threshold. It takes the quality values and slides a window across them whose length is 0.1 times the length of the read. If this length is less than 1, then the window is set to be equal to the length of the read. Otherwise, the window slides along the quality values until the average quality in the window rises above the threshold, at which point the algorithm determines where within the window the rise occurs and cuts the read and quality there for the 5'-end cut. Then when the average quality in the window drops below the threshold, the algorithm determines where in the window the drop occurs and cuts both the read and quality strings there for the 3'-end cut. However, if the length of the remaining sequence is less than the minimum length threshold, then the read is discarded entirely. 5'-end trimming can be disabled.
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
92
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
93 Sickle also has an option to discard reads with any Ns in them.
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
94
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
95 Sickle supports three types of quality values: Illumina, Solexa, and Sanger. Note that the Solexa quality setting is an approximation (the actual conversion is a non-linear transformation). The end approximation is close. Illumina quality refers to qualities encoded with the CASAVA pipeline between versions 1.3 and 1.7. Illumina quality using CASAVA >= 1.8 is Sanger encoded.
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
96
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
97 Note that Sickle will remove the 2nd fastq record header (on the "+" line) and replace it with simply a "+". This is the default format for CASAVA >= 1.8.
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
98
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
99 Sickle also supports gzipped file inputs.
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
100 </help>
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
101
c522aaea6880 Uploaded
nilesh
parents:
diff changeset
102 </tool>