annotate trimmomatic.xml @ 1:2bd7cdbb6228 draft

Add README and citation tags.
author pjbriggs
date Tue, 09 Dec 2014 09:41:33 -0500
parents 3358c3d30143
children a60283899c6d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
1 <tool id="trimmomatic" name="Trimmomatic" version="0.32.1">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
2 <description>flexible read trimming tool for Illumina NGS data</description>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
3 <command interpreter="bash">trimmomatic.sh
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
4 -mx8G
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
5 -jar \$TRIMMOMATIC_DIR/trimmomatic-0.32.jar
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
6 #if $paired_end.is_paired_end
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
7 PE -threads 6 -phred33 $fastq_r1_in $paired_end.fastq_r2_in $fastq_out_r1_paired $fastq_out_r1_unpaired $fastq_out_r2_paired $fastq_out_r2_unpaired
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
8 #else
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
9 SE -threads 6 -phred33 $fastq_in $fastq_out
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
10 #end if
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
11 ## ILLUMINACLIP option
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
12 #if $illuminaclip.do_illuminaclip
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
13 ILLUMINACLIP:\$TRIMMOMATIC_ADAPTERS_DIR/$illuminaclip.adapter_fasta:$illuminaclip.seed_mismatches:$illuminaclip.palindrome_clip_threshold:$illuminaclip.simple_clip_threshold
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
14 #end if
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
15 ## Other operations
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
16 #for $op in $operations
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
17 ## SLIDINGWINDOW
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
18 #if str( $op.operation.name ) == "SLIDINGWINDOW"
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
19 SLIDINGWINDOW:$op.operation.window_size:$op.operation.required_quality
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
20 #end if
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
21 ## MINLEN:36
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
22 #if str( $op.operation.name ) == "MINLEN"
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
23 MINLEN:$op.operation.minlen
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
24 #end if
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
25 #if str( $op.operation.name ) == "LEADING"
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
26 LEADING:$op.operation.leading
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
27 #end if
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
28 #if str( $op.operation.name ) == "TRAILING"
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
29 TRAILING:$op.operation.trailing
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
30 #end if
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
31 #if str( $op.operation.name ) == "CROP"
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
32 CROP:$op.operation.crop
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
33 #end if
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
34 #if str( $op.operation.name ) == "HEADCROP"
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
35 HEADCROP:$op.operation.headcrop
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
36 #end if
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
37 #end for
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
38 </command>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
39 <requirements>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
40 <requirement type="package" version="0.32">trimmomatic</requirement>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
41 </requirements>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
42 <inputs>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
43 <conditional name="paired_end">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
44 <param name="is_paired_end" type="boolean" label="Paired end data?" truevalue="yes" falsevalue="no" checked="on" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
45 <when value="no">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
46 <param name="fastq_in" type="data" format="fastqsanger" label="Input FASTQ file" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
47 </when>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
48 <when value="yes">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
49 <param name="fastq_r1_in" type="data" format="fastqsanger"
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
50 label="Input FASTQ file (R1/first of pair)" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
51 <param name="fastq_r2_in" type="data" format="fastqsanger"
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
52 label="Input FASTQ file (R2/second of pair)" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
53 </when>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
54 </conditional>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
55 <conditional name="illuminaclip">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
56 <param name="do_illuminaclip" type="boolean" label="Perform initial ILLUMINACLIP step?" help="Cut adapter and other illumina-specific sequences from the read" truevalue="yes" falsevalue="no" checked="off" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
57 <when value="yes">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
58 <param name="adapter_fasta" type="select" label="Adapter sequences to use">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
59 <option value="TruSeq2-SE.fa">TruSeq2 (single-ended, for Illumina GAII)</option>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
60 <option value="TruSeq3-SE.fa">TruSeq3 (single-ended, for MiSeq and HiSeq)</option>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
61 <option value="TruSeq2-PE.fa">TruSeq2 (paired-ended, for Illumina GAII)</option>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
62 <option value="TruSeq3-PE.fa">TruSeq3 (paired-ended, for MiSeq and HiSeq)</option>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
63 <option value="TruSeq3-PE-2.fa">TruSeq3 (additional seqs) (paired-ended, for MiSeq and HiSeq)</option>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
64 <option value="NexteraPE-PE.fa">Nextera (paired-ended)</option>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
65 </param>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
66 <param name="seed_mismatches" type="integer" label="Maximum mismatch count which will still allow a full match to be performed" value="2" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
67 <param name="palindrome_clip_threshold" type="integer" label="How accurate the match between the two 'adapter ligated' reads must be for PE palindrome read alignment" value="30" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
68 <param name="simple_clip_threshold" type="integer" label="How accurate the match between any adapter etc. sequence must be against a read" value="10" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
69 </when>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
70 </conditional>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
71 <repeat name="operations" title="Trimmomatic Operation" min="1">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
72 <conditional name="operation">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
73 <param name="name" type="select" label="Select Trimmomatic operation to perform">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
74 <option selected="true" value="SLIDINGWINDOW">Sliding window trimming (SLIDINGWINDOW)</option>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
75 <option value="MINLEN">Drop reads below a specified length (MINLEN)</option>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
76 <option value="LEADING">Cut bases off the start of a read, if below a threshold quality (LEADING)</option>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
77 <option value="TRAILING">Cut bases off the end of a read, if below a threshold quality (TRAILING)</option>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
78 <option value="CROP">Cut the read to a specified length (CROP)</option>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
79 <option value="HEADCROP">Cut the specified number of bases from the start of the read (HEADCROP)</option>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
80 </param>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
81 <when value="SLIDINGWINDOW">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
82 <param name="window_size" type="integer" label="Number of bases to average across" value="4" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
83 <param name="required_quality" type="integer" label="Average quality required" value="20" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
84 </when>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
85 <when value="MINLEN">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
86 <param name="minlen" type="integer" label="Minimum length of reads to be kept" value="20" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
87 </when>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
88 <when value="LEADING">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
89 <param name="leading" type="integer" label="Minimum quality required to keep a base" value="3" help="Bases at the start of the read with quality below the threshold will be removed" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
90 </when>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
91 <when value="TRAILING">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
92 <param name="trailing" type="integer" label="Minimum quality required to keep a base" value="3" help="Bases at the end of the read with quality below the threshold will be removed" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
93 </when>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
94 <when value="CROP">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
95 <param name="crop" type="integer" label="Number of bases to keep from the start of the read" value="" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
96 </when>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
97 <when value="HEADCROP">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
98 <param name="headcrop" type="integer" label="Number of bases to remove from the start of the read" value="" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
99 </when>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
100 </conditional>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
101 </repeat>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
102 </inputs>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
103 <outputs>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
104 <data format="fastqsanger" name="fastq_out_r1_paired" label="${tool.name} on ${on_string} (R1 paired)">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
105 <filter>paired_end['is_paired_end']</filter>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
106 </data>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
107 <data format="fastqsanger" name="fastq_out_r1_unpaired" label="${tool.name} on ${on_string} (R1 unpaired)">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
108 <filter>paired_end['is_paired_end']</filter>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
109 </data>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
110 <data format="fastqsanger" name="fastq_out_r2_paired" label="${tool.name} on ${on_string} (R2 paired)">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
111 <filter>paired_end['is_paired_end']</filter>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
112 </data>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
113 <data format="fastqsanger" name="fastq_out_r2_unpaired" label="${tool.name} on ${on_string} (R2 unpaired)">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
114 <filter>paired_end['is_paired_end']</filter>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
115 </data>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
116 <data format="fastqsanger" name="fastq_out" label="${tool.name} on ${on_string}">
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
117 <filter>not paired_end['is_paired_end']</filter>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
118 </data>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
119 </outputs>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
120 <tests>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
121 <test>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
122 <!-- Single-end example -->
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
123 <param name="is_paired_end" value="no" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
124 <param name="fastq_in" value="Illumina_SG_R1.fastq" ftype="fastqsanger" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
125 <param name="operations_0|operation|name" value="SLIDINGWINDOW" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
126 <!--
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
127 **NB** outputs have to be specified in order that they appear in the
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
128 tool (which is the order they will be written to the history) - the
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
129 test framework seems to use the order and ignores the "name" attribute
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
130 -->
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
131 <output name="fastq_out" file="trimmomatic_se_out1.fastq" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
132 </test>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
133 <test>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
134 <!-- Paired-end example -->
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
135 <param name="is_paired_end" value="yes" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
136 <param name="fastq_r1_in" value="Illumina_SG_R1.fastq" ftype="fastqsanger" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
137 <param name="fastq_r2_in" value="Illumina_SG_R2.fastq" ftype="fastqsanger" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
138 <param name="operations_0|operation|name" value="SLIDINGWINDOW" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
139 <!--
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
140 **NB** outputs have to be specified in order that they appear in the
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
141 tool (which is the order they will be written to the history) - the
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
142 test framework seems to use the order and ignores the "name" attribute
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
143 -->
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
144 <output name="fastq_out_r1_paired" file="trimmomatic_pe_r1_paired_out1.fastq" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
145 <output name="fastq_out_r1_unpaired" file="trimmomatic_pe_r1_unpaired_out1.fastq" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
146 <output name="fastq_out_r2_paired" file="trimmomatic_pe_r2_paired_out1.fastq" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
147 <output name="fastq_out_r2_unpaired" file="trimmomatic_pe_r2_unpaired_out1.fastq" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
148 </test>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
149 <test>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
150 <!-- Single-end example (cropping) -->
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
151 <param name="is_paired_end" value="no" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
152 <param name="fastq_in" value="Illumina_SG_R1.fastq" ftype="fastqsanger" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
153 <param name="operations_0|operation|name" value="CROP" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
154 <param name="operations_0|operation|crop" value="10" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
155 <!--
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
156 **NB** outputs have to be specified in order that they appear in the
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
157 tool (which is the order they will be written to the history) - the
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
158 test framework seems to use the order and ignores the "name" attribute
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
159 -->
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
160 <output name="fastq_out" file="trimmomatic_se_out2.fastq" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
161 </test>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
162 </tests>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
163 <help>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
164 .. class:: infomark
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
165
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
166 **What it does**
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
167
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
168 Trimmomatic performs a variety of useful trimming tasks for illumina paired-end and
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
169 single ended data.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
170
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
171 This tool allows the following trimming steps to be performed:
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
172
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
173 * **ILLUMINACLIP:** Cut adapter and other illumina-specific sequences from the read
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
174 * **SLIDINGWINDOW:** Perform a sliding window trimming, cutting once the average
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
175 quality within the window falls below a threshold
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
176 * **MINLEN:** Drop the read if it is below a specified length
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
177 * **LEADING:** Cut bases off the start of a read, if below a threshold quality
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
178 * **TRAILING:** Cut bases off the end of a read, if below a threshold quality
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
179 * **CROP:** Cut the read to a specified length
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
180 * **HEADCROP:** Cut the specified number of bases from the start of the read
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
181
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
182 If ILLUMINACLIP is requested then it is always performed first; subsequent options
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
183 can be mixed and matched and will be performed in the order that they have been
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
184 specified.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
185
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
186 .. class:: warningmark
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
187
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
188 Note that trimming operation order is important.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
189
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
190 -------------
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
191
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
192 .. class:: infomark
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
193
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
194 **Outputs**
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
195
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
196 For paired-end data a particular strength of Trimmomatic is that it retains the
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
197 pairing of reads (from R1 and R2) in the filtered output files:
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
198
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
199 * Two FASTQ files (R1-paired and R2-paired) contain one read from each pair where
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
200 both have survived filtering.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
201 * Additionally two FASTQ files (R1-unpaired and R2-unpaired) contain reads where
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
202 one of the pair failed the filtering steps.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
203
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
204 Retaining the same order and number of reads in the filtered output fastq files is
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
205 essential for many downstream analysis tools.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
206
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
207 For single-end data the output is a single FASTQ file containing just the filtered
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
208 reads.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
209
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
210 -------------
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
211
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
212 .. class:: infomark
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
213
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
214 **Credits**
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
215
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
216 This Galaxy tool has been developed within the Bioinformatics Core Facility at the
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
217 University of Manchester. It runs the Trimmomatic program which has been developed
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
218 within Bjorn Usadel's group at RWTH Aachen university.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
219
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
220 Trimmomatic website (including documentation):
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
221
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
222 * http://www.usadellab.org/cms/index.php?page=trimmomatic
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
223
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
224 The reference for Trimmomatic is:
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
225
1
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents: 0
diff changeset
226 * Bolger, A.M., Lohse, M., &amp; Usadel, B. (2014). Trimmomatic: A flexible trimmer
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents: 0
diff changeset
227 for Illumina Sequence Data. Bioinformatics, btu170.
0
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
228
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
229 Please kindly acknowledge both this Galaxy tool and the Trimmomatic program if you
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
230 use it.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
231 </help>
1
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents: 0
diff changeset
232 <citations>
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents: 0
diff changeset
233 <!--
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents: 0
diff changeset
234 See https://wiki.galaxyproject.org/Admin/Tools/ToolConfigSyntax#A.3Ccitations.3E_tag_set
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents: 0
diff changeset
235 Can be either DOI or Bibtex
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents: 0
diff changeset
236 Use http://www.bioinformatics.org/texmed/ to convert PubMed to Bibtex
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents: 0
diff changeset
237 -->
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents: 0
diff changeset
238 <citation type="doi">10.1093/bioinformatics/btu170</citation>
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents: 0
diff changeset
239 </citations>
0
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
240 </tool>