Mercurial > repos > pjbriggs > trimmomatic
annotate trimmomatic.xml @ 9:a775e9fda0ca draft
Uploaded version 0.36.4 for testing.
| author | pjbriggs |
|---|---|
| date | Thu, 22 Jun 2017 08:57:22 -0400 |
| parents | a923b799c77c |
| children | 3c9479ab24c3 |
| rev | line source |
|---|---|
| 9 | 1 <tool id="trimmomatic" name="Trimmomatic" version="0.36.4"> |
| 1 | 2 <description>flexible read trimming tool for Illumina NGS data</description> |
|
5
b0315888eb4d
Test for version which is compatible with conda dependency resolver.
pjbriggs
parents:
4
diff
changeset
|
3 <macros> |
|
b0315888eb4d
Test for version which is compatible with conda dependency resolver.
pjbriggs
parents:
4
diff
changeset
|
4 <import>trimmomatic_macros.xml</import> |
|
b0315888eb4d
Test for version which is compatible with conda dependency resolver.
pjbriggs
parents:
4
diff
changeset
|
5 </macros> |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
6 <requirements> |
| 4 | 7 <requirement type="package" version="0.36">trimmomatic</requirement> |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
8 </requirements> |
| 7 | 9 <command detect_errors="aggressive"><![CDATA[ |
|
5
b0315888eb4d
Test for version which is compatible with conda dependency resolver.
pjbriggs
parents:
4
diff
changeset
|
10 @CONDA_TRIMMOMATIC_JAR_PATH@ && |
|
b0315888eb4d
Test for version which is compatible with conda dependency resolver.
pjbriggs
parents:
4
diff
changeset
|
11 @CONDA_TRIMMOMATIC_ADAPTERS_PATH@ && |
| 7 | 12 #if $readtype.single_or_paired == "pair_of_files" |
| 13 #set r1_ext = $readtype.fastq_r1_in.extension | |
| 14 #set r2_ext = $readtype.fastq_r2_in.extension | |
| 15 ln -s '$readtype.fastq_r1_in' fastq_r1.'$r1_ext' && | |
| 16 ln -s '$readtype.fastq_r2_in' fastq_r2.'$r2_ext' && | |
| 17 #elif $readtype.single_or_paired == "collection" | |
| 18 #set r1_ext = $readtype.fastq_pair.forward.extension | |
| 19 #set r2_ext = $readtype.fastq_pair.reverse.extension | |
| 20 ln -s '$readtype.fastq_pair.forward' fastq_r1.'$r1_ext' && | |
| 21 ln -s '$readtype.fastq_pair.reverse' fastq_r2.'$r2_ext' && | |
| 22 #else | |
| 23 ln -s '$fastq_in' fastq_in.'$fastq_in.extension' && | |
| 24 #end if | |
| 25 java \${_JAVA_OPTIONS:--Xmx8G} -jar \$TRIMMOMATIC_JAR_PATH/trimmomatic.jar | |
| 26 #if $readtype.single_or_paired in ["pair_of_files","collection"] | |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
27 PE -threads \${GALAXY_SLOTS:-6} -phred33 |
| 7 | 28 fastq_r1.'$r1_ext' fastq_r2.'$r2_ext' |
| 29 fastq_out_r1_paired.'$r1_ext' fastq_out_r1_unpaired.'$r1_ext' | |
| 30 fastq_out_r2_paired.'$r2_ext' fastq_out_r2_unpaired.'$r2_ext' | |
| 1 | 31 #else |
| 7 | 32 SE -threads \${GALAXY_SLOTS:-6} -phred33 fastq_in.'$fastq_in.extension' fastq_out.'$fastq_in.extension' |
| 1 | 33 #end if |
| 34 ## ILLUMINACLIP option | |
| 35 #if $illuminaclip.do_illuminaclip | |
| 9 | 36 #if $illuminaclip.adapter_type.standard_or_custom == "custom" |
| 37 #if $readtype.single_or_paired in ["pair_of_files","collection"] | |
| 38 ILLUMINACLIP:$adapter_file_from_text:$illuminaclip.seed_mismatches:$illuminaclip.palindrome_clip_threshold:$illuminaclip.simple_clip_threshold:$illuminaclip.min_adapter_len:$illuminaclip.keep_both_reads | |
| 39 #else | |
| 40 ILLUMINACLIP:$adapter_file_from_text:$illuminaclip.seed_mismatches:$illuminaclip.palindrome_clip_threshold:$illuminaclip.simple_clip_threshold | |
| 41 #end if | |
| 42 #else | |
| 43 #if $readtype.single_or_paired in ["pair_of_files","collection"] | |
| 44 ILLUMINACLIP:\$TRIMMOMATIC_ADAPTERS_PATH/$illuminaclip.adapter_type.adapter_fasta:$illuminaclip.seed_mismatches:$illuminaclip.palindrome_clip_threshold:$illuminaclip.simple_clip_threshold:$illuminaclip.min_adapter_len:$illuminaclip.keep_both_reads | |
| 45 #else | |
| 46 ILLUMINACLIP:\$TRIMMOMATIC_ADAPTERS_PATH/$illuminaclip.adapter_type.adapter_fasta:$illuminaclip.seed_mismatches:$illuminaclip.palindrome_clip_threshold:$illuminaclip.simple_clip_threshold | |
| 47 #end if | |
| 48 #end if | |
| 1 | 49 #end if |
| 50 ## Other operations | |
| 51 #for $op in $operations | |
| 52 ## SLIDINGWINDOW | |
| 53 #if str( $op.operation.name ) == "SLIDINGWINDOW" | |
| 54 SLIDINGWINDOW:$op.operation.window_size:$op.operation.required_quality | |
| 55 #end if | |
| 56 ## MINLEN:36 | |
| 57 #if str( $op.operation.name ) == "MINLEN" | |
| 58 MINLEN:$op.operation.minlen | |
| 59 #end if | |
| 60 #if str( $op.operation.name ) == "LEADING" | |
| 61 LEADING:$op.operation.leading | |
| 62 #end if | |
| 63 #if str( $op.operation.name ) == "TRAILING" | |
| 64 TRAILING:$op.operation.trailing | |
| 65 #end if | |
| 66 #if str( $op.operation.name ) == "CROP" | |
| 67 CROP:$op.operation.crop | |
| 68 #end if | |
| 69 #if str( $op.operation.name ) == "HEADCROP" | |
| 70 HEADCROP:$op.operation.headcrop | |
| 71 #end if | |
| 4 | 72 #if str( $op.operation.name ) == "AVGQUAL" |
| 73 AVGQUAL:$op.operation.avgqual | |
| 74 #end if | |
| 75 #if str( $op.operation.name ) == "MAXINFO" | |
| 76 MAXINFO:$op.operation.target_length:$op.operation.strictness | |
| 77 #end if | |
| 1 | 78 #end for |
|
5
b0315888eb4d
Test for version which is compatible with conda dependency resolver.
pjbriggs
parents:
4
diff
changeset
|
79 2>&1 | tee trimmomatic.log && |
|
b0315888eb4d
Test for version which is compatible with conda dependency resolver.
pjbriggs
parents:
4
diff
changeset
|
80 if [ -z "\$(tail -1 trimmomatic.log | grep "Completed successfully")" ]; then echo "Trimmomatic did not finish successfully" >&2 ; exit 1 ; fi |
| 7 | 81 && |
| 82 #if $readtype.single_or_paired == "pair_of_files" | |
| 83 mv fastq_out_r1_paired.'$r1_ext' '${fastq_out_r1_paired}' && | |
| 84 mv fastq_out_r1_unpaired.'$r1_ext' '${fastq_out_r1_unpaired}' && | |
| 85 mv fastq_out_r2_paired.'$r2_ext' '${fastq_out_r2_paired}' && | |
| 86 mv fastq_out_r2_unpaired.'$r2_ext' '${fastq_out_r2_unpaired}' | |
| 87 #elif $readtype.single_or_paired == "collection" | |
| 88 mv fastq_out_r1_paired.'$r1_ext' '${fastq_out_paired.forward}' && | |
| 89 mv fastq_out_r1_unpaired.'$r1_ext' '${fastq_out_unpaired.forward}' && | |
| 90 mv fastq_out_r2_paired.'$r2_ext' '${fastq_out_paired.reverse}' && | |
| 91 mv fastq_out_r2_unpaired.'$r2_ext' '${fastq_out_unpaired.reverse}' | |
| 92 #else | |
| 93 mv fastq_out.'$fastq_in.extension' '${fastq_out}' | |
| 94 #end if | |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
95 ]]></command> |
| 9 | 96 <configfiles> |
| 97 <configfile name="adapter_file_from_text">#set from_text_area = '' | |
| 98 #if str( $illuminaclip.do_illuminaclip ) == "yes" and str( $illuminaclip.adapter_type.standard_or_custom ) == "custom": | |
| 99 #set from_text_area = $illuminaclip.adapter_type.adapter_text | |
| 100 #end if | |
| 101 ${from_text_area}</configfile> | |
| 102 </configfiles> | |
| 103 | |
| 1 | 104 <inputs> |
| 7 | 105 <conditional name="readtype"> |
| 106 <param name="single_or_paired" type="select" label="Single-end or paired-end reads?"> | |
| 107 <option value="se" selected="true">Single-end</option> | |
| 108 <option value="pair_of_files">Paired-end (two separate input files)</option> | |
| 109 <option value="collection">Paired-end (as collection)</option> | |
| 110 </param> | |
| 111 <when value="se"> | |
| 112 <param name="fastq_in" type="data" format="fastqsanger,fastqsanger.gz" label="Input FASTQ file" /> | |
| 1 | 113 </when> |
| 7 | 114 <when value="pair_of_files"> |
| 115 <param name="fastq_r1_in" type="data" format="fastqsanger,fastqsanger.gz" | |
| 116 label="Input FASTQ file (R1/first of pair)" /> | |
| 117 <param name="fastq_r2_in" type="data" format="fastqsanger,fastqgsanger.gz" | |
| 118 label="Input FASTQ file (R2/second of pair)" /> | |
| 1 | 119 </when> |
| 7 | 120 <when value="collection"> |
| 121 <param name="fastq_pair" format="fastqsanger,fastqsanger.gz" type="data_collection" collection_type="paired" label="Select FASTQ dataset collection with R1/R2 pair" /> | |
| 122 </when> | |
| 1 | 123 </conditional> |
| 124 <conditional name="illuminaclip"> | |
| 7 | 125 <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="False" /> |
| 126 <when value="yes"> | |
| 9 | 127 <conditional name="adapter_type"> |
| 128 <param name="standard_or_custom" type="select" label="Select standard adapter sequences or provide custom?"> | |
| 129 <option value="standard" selected="true">Standard</option> | |
| 130 <option value="custom">Custom</option> | |
| 131 </param> | |
| 132 <when value="standard"> | |
| 133 <param name="adapter_fasta" type="select" label="Adapter sequences to use"> | |
| 134 <option value="TruSeq2-SE.fa">TruSeq2 (single-ended, for Illumina GAII)</option> | |
| 135 <option value="TruSeq3-SE.fa">TruSeq3 (single-ended, for MiSeq and HiSeq)</option> | |
| 136 <option value="TruSeq2-PE.fa">TruSeq2 (paired-ended, for Illumina GAII)</option> | |
| 137 <option value="TruSeq3-PE.fa">TruSeq3 (paired-ended, for MiSeq and HiSeq)</option> | |
| 138 <option value="TruSeq3-PE-2.fa">TruSeq3 (additional seqs) (paired-ended, for MiSeq and HiSeq)</option> | |
| 139 <option value="NexteraPE-PE.fa">Nextera (paired-ended)</option> | |
| 140 </param> | |
| 141 </when> | |
| 142 <when value="custom"> | |
| 143 <param name="adapter_text" type="text" area="True" size="10x30" value="" | |
| 144 label="Custom adapter sequences in fasta format" help="Write sequences in the fasta format."> | |
| 145 <sanitizer> | |
| 146 <valid initial="string.printable"></valid> | |
| 147 <mapping initial="none"/> | |
| 148 </sanitizer> | |
| 149 </param> | |
| 150 </when> | |
| 151 </conditional> | |
| 7 | 152 <param name="seed_mismatches" type="integer" label="Maximum mismatch count which will still allow a full match to be performed" value="2" /> |
| 153 <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" /> | |
| 154 <param name="simple_clip_threshold" type="integer" label="How accurate the match between any adapter etc. sequence must be against a read" value="10" /> | |
| 9 | 155 <param name="min_adapter_len" type="integer" label="Minimum length of adapter that needs to be detected (PE specific/palindrome mode)" value="8" /> |
| 156 <param name="keep_both_reads" type="boolean" label="Always keep both reads (PE specific/palindrome mode)?" truevalue="true" falsevalue="false" checked="true" | |
| 157 help="See help below"/> | |
| 7 | 158 </when> |
| 159 <when value="no" /> <!-- empty clause to satisfy planemo lint --> | |
| 1 | 160 </conditional> |
| 161 <repeat name="operations" title="Trimmomatic Operation" min="1"> | |
| 162 <conditional name="operation"> | |
| 7 | 163 <param name="name" type="select" label="Select Trimmomatic operation to perform"> |
| 164 <option selected="true" value="SLIDINGWINDOW">Sliding window trimming (SLIDINGWINDOW)</option> | |
| 165 <option value="MINLEN">Drop reads below a specified length (MINLEN)</option> | |
| 166 <option value="LEADING">Cut bases off the start of a read, if below a threshold quality (LEADING)</option> | |
| 167 <option value="TRAILING">Cut bases off the end of a read, if below a threshold quality (TRAILING)</option> | |
| 168 <option value="CROP">Cut the read to a specified length (CROP)</option> | |
| 169 <option value="HEADCROP">Cut the specified number of bases from the start of the read (HEADCROP)</option> | |
| 170 <option value="AVGQUAL">Drop reads with average quality lower than a specified level (AVGQUAL)</option> | |
| 171 <option value="MAXINFO">Trim reads adaptively, balancing read length and error rate to maximise the value of each read (MAXINFO)</option> | |
| 172 </param> | |
| 173 <when value="SLIDINGWINDOW"> | |
| 174 <param name="window_size" type="integer" label="Number of bases to average across" value="4" /> | |
| 175 <param name="required_quality" type="integer" label="Average quality required" value="20" /> | |
| 176 </when> | |
| 177 <when value="MINLEN"> | |
| 178 <param name="minlen" type="integer" label="Minimum length of reads to be kept" value="20" /> | |
| 179 </when> | |
| 180 <when value="LEADING"> | |
| 181 <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" /> | |
| 182 </when> | |
| 183 <when value="TRAILING"> | |
| 184 <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" /> | |
| 185 </when> | |
| 186 <when value="CROP"> | |
| 187 <param name="crop" type="integer" label="Number of bases to keep from the start of the read" value="" /> | |
| 188 </when> | |
| 189 <when value="HEADCROP"> | |
| 190 <param name="headcrop" type="integer" label="Number of bases to remove from the start of the read" value="" /> | |
| 191 </when> | |
| 192 <when value="AVGQUAL"> | |
| 193 <param name="avgqual" type="integer" label="Minimum average quality required to keep a read" value="" /> | |
| 194 </when> | |
| 195 <when value="MAXINFO"> | |
| 196 <param name="target_length" type="integer" label="Target read length" value="" help="The read length which is likely to allow the location of the read within the target sequence to be determined." /> | |
| 197 <param name="strictness" type="float" label="Strictness" value="" help="Set between zero and one - specifies the balance between preserving read length versus removal of incorrect bases; low values (<0.2) favours longer reads, high values (>0.8) favours read correctness." /> | |
| 198 </when> | |
| 1 | 199 </conditional> |
| 200 </repeat> | |
| 201 </inputs> | |
| 202 <outputs> | |
| 7 | 203 <data name="fastq_out_r1_paired" label="${tool.name} on ${readtype.fastq_r1_in.name} (R1 paired)" format_source="fastq_r1_in"> |
| 204 <filter>readtype['single_or_paired'] == "pair_of_files"</filter> | |
| 1 | 205 </data> |
| 7 | 206 <data name="fastq_out_r2_paired" label="${tool.name} on ${readtype.fastq_r2_in.name} (R2 paired)" format_source="fastq_r2_in"> |
| 207 <filter>readtype['single_or_paired'] == "pair_of_files"</filter> | |
| 1 | 208 </data> |
| 7 | 209 <data name="fastq_out_r1_unpaired" label="${tool.name} on ${readtype.fastq_r1_in.name} (R1 unpaired)" format_source="fastq_r1_in"> |
| 210 <filter>readtype['single_or_paired'] == "pair_of_files"</filter> | |
| 1 | 211 </data> |
| 7 | 212 <data name="fastq_out_r2_unpaired" label="${tool.name} on ${readtype.fastq_r2_in.name} (R2 unpaired)" format_source="fastq_r2_in"> |
| 213 <filter>readtype['single_or_paired'] == "pair_of_files"</filter> | |
| 1 | 214 </data> |
| 7 | 215 <data name="fastq_out" label="${tool.name} on ${readtype.fastq_in.name}" format_source="fastq_in"> |
| 216 <filter>readtype['single_or_paired'] == 'se'</filter> | |
| 1 | 217 </data> |
|
8
a923b799c77c
Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents:
7
diff
changeset
|
218 <collection name="fastq_out_paired" type="paired" label="${tool.name} on ${on_string}: paired"> |
| 7 | 219 <filter>readtype['single_or_paired'] == "collection"</filter> |
| 220 <data name="forward" label="${tool.name} on ${readtype.fastq_pair.forward.name} (R1 paired)" format_source="fastq_pair['forward']"/> | |
| 221 <data name="reverse" label="${tool.name} on ${readtype.fastq_pair.reverse.name} (R2 paired)" format_source="fastq_pair['reverse']"/> | |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
222 </collection> |
|
8
a923b799c77c
Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents:
7
diff
changeset
|
223 <collection name="fastq_out_unpaired" type="paired" label="${tool.name} on ${on_string}: unpaired"> |
| 7 | 224 <filter>readtype['single_or_paired'] == "collection"</filter> |
| 225 <data name="forward" label="${tool.name} on ${readtype.fastq_pair.forward.name} (R1 unpaired)" format_source="fastq_pair['forward']"/> | |
| 226 <data name="reverse" label="${tool.name} on ${readtype.fastq_pair.reverse.name} (R2 unpaired)" format_source="fastq_pair['reverse']"/> | |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
227 </collection> |
| 7 | 228 |
| 1 | 229 </outputs> |
| 230 <tests> | |
| 231 <test> | |
| 232 <!-- Single-end example --> | |
| 7 | 233 <param name="single_or_paired" value="se" /> |
| 1 | 234 <param name="fastq_in" value="Illumina_SG_R1.fastq" ftype="fastqsanger" /> |
| 235 <param name="operations_0|operation|name" value="SLIDINGWINDOW" /> | |
| 236 <output name="fastq_out" file="trimmomatic_se_out1.fastq" /> | |
| 237 </test> | |
| 238 <test> | |
| 7 | 239 <!-- Single-end example - gzipped --> |
| 240 <param name="single_or_paired" value="se" /> | |
| 241 <param name="fastq_in" value="Illumina_SG_R1.fastq.gz" ftype="fastqsanger.gz" /> | |
| 242 <param name="operations_0|operation|name" value="SLIDINGWINDOW" /> | |
| 243 <output name="fastq_out" file="trimmomatic_se_out1.fastq.gz" /> | |
| 244 </test> | |
| 245 <test> | |
| 246 <!-- Paired-end example - gzipped --> | |
| 247 <param name="single_or_paired" value="pair_of_files" /> | |
| 248 <param name="fastq_r1_in" value="Illumina_SG_R1.fastq.gz" ftype="fastqsanger.gz" /> | |
| 249 <param name="fastq_r2_in" value="Illumina_SG_R2.fastq.gz" ftype="fastqsanger.gz" /> | |
| 250 <param name="operations_0|operation|name" value="SLIDINGWINDOW" /> | |
| 251 <output name="fastq_out_r1_paired" file="trimmomatic_pe_r1_paired_out1.fastq.gz" /> | |
| 252 <output name="fastq_out_r1_unpaired" file="trimmomatic_pe_r1_unpaired_out1.fastq.gz" /> | |
| 253 <output name="fastq_out_r2_paired" file="trimmomatic_pe_r2_paired_out1.fastq.gz" /> | |
| 254 <output name="fastq_out_r2_unpaired" file="trimmomatic_pe_r2_unpaired_out1.fastq.gz" /> | |
| 255 </test> | |
| 256 <test> | |
| 1 | 257 <!-- Paired-end example --> |
| 7 | 258 <param name="single_or_paired" value="pair_of_files" /> |
| 1 | 259 <param name="fastq_r1_in" value="Illumina_SG_R1.fastq" ftype="fastqsanger" /> |
| 260 <param name="fastq_r2_in" value="Illumina_SG_R2.fastq" ftype="fastqsanger" /> | |
| 261 <param name="operations_0|operation|name" value="SLIDINGWINDOW" /> | |
| 262 <output name="fastq_out_r1_paired" file="trimmomatic_pe_r1_paired_out1.fastq" /> | |
| 263 <output name="fastq_out_r1_unpaired" file="trimmomatic_pe_r1_unpaired_out1.fastq" /> | |
| 264 <output name="fastq_out_r2_paired" file="trimmomatic_pe_r2_paired_out1.fastq" /> | |
| 265 <output name="fastq_out_r2_unpaired" file="trimmomatic_pe_r2_unpaired_out1.fastq" /> | |
| 266 </test> | |
| 267 <test> | |
| 268 <!-- Single-end example (cropping) --> | |
| 7 | 269 <param name="single_or_paired" value="se" /> |
| 1 | 270 <param name="fastq_in" value="Illumina_SG_R1.fastq" ftype="fastqsanger" /> |
| 271 <param name="operations_0|operation|name" value="CROP" /> | |
| 272 <param name="operations_0|operation|crop" value="10" /> | |
| 273 <output name="fastq_out" file="trimmomatic_se_out2.fastq" /> | |
| 274 </test> | |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
275 <test> |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
276 <!-- Paired-end with dataset collection --> |
| 7 | 277 <param name="single_or_paired" value="collection" /> |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
278 <param name="fastq_pair"> |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
279 <collection type="paired"> |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
280 <element name="forward" value="Illumina_SG_R1.fastq" ftype="fastqsanger" /> |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
281 <element name="reverse" value="Illumina_SG_R2.fastq" ftype="fastqsanger"/> |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
282 </collection> |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
283 </param> |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
284 <param name="operations_0|operation|name" value="SLIDINGWINDOW" /> |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
285 <output_collection name="fastq_out_paired" type="paired"> |
| 7 | 286 <element name="forward" file="trimmomatic_pe_r1_paired_out1.fastq" /> |
| 287 <element name="reverse" file="trimmomatic_pe_r2_paired_out1.fastq" /> | |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
288 </output_collection> |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
289 <output_collection name="fastq_out_unpaired" type="paired"> |
| 7 | 290 <element name="forward" file="trimmomatic_pe_r1_unpaired_out1.fastq" /> |
| 291 <element name="reverse" file="trimmomatic_pe_r2_unpaired_out1.fastq" /> | |
| 292 </output_collection> | |
| 293 </test> | |
| 294 <test> | |
| 295 <!-- Paired-end with dataset collection - gzipped --> | |
| 296 <param name="single_or_paired" value="collection" /> | |
| 297 <param name="fastq_pair"> | |
| 298 <collection type="paired"> | |
| 299 <element name="forward" value="Illumina_SG_R1.fastq.gz" ftype="fastqsanger.gz" /> | |
| 300 <element name="reverse" value="Illumina_SG_R2.fastq.gz" ftype="fastqsanger.gz"/> | |
| 301 </collection> | |
| 302 </param> | |
| 303 <param name="operations_0|operation|name" value="SLIDINGWINDOW" /> | |
| 304 <output_collection name="fastq_out_paired" type="paired"> | |
| 305 <element name="forward" file="trimmomatic_pe_r1_paired_out1.fastq.gz" /> | |
| 306 <element name="reverse" file="trimmomatic_pe_r2_paired_out1.fastq.gz" /> | |
| 307 </output_collection> | |
| 308 <output_collection name="fastq_out_unpaired" type="paired"> | |
| 309 <element name="forward" file="trimmomatic_pe_r1_unpaired_out1.fastq.gz" /> | |
| 310 <element name="reverse" file="trimmomatic_pe_r2_unpaired_out1.fastq.gz" /> | |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
311 </output_collection> |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
312 </test> |
| 4 | 313 <test> |
| 314 <!-- Single-end using AVGQUAL --> | |
| 7 | 315 <param name="single_or_paired" value="se" /> |
| 4 | 316 <param name="fastq_in" value="Illumina_SG_R1.fastq" ftype="fastqsanger" /> |
| 317 <param name="operations_0|operation|name" value="AVGQUAL" /> | |
| 318 <param name="operations_0|operation|avgqual" value="30" /> | |
| 319 <output name="fastq_out" file="trimmomatic_avgqual.fastq" /> | |
| 320 </test> | |
| 321 <test> | |
| 322 <!-- Single-end using MAXINFO --> | |
| 7 | 323 <param name="single_or_paired" value="se" /> |
| 4 | 324 <param name="fastq_in" value="Illumina_SG_R1.fastq" ftype="fastqsanger" /> |
| 325 <param name="operations_0|operation|name" value="MAXINFO" /> | |
| 326 <param name="operations_0|operation|target_length" value="75" /> | |
| 327 <param name="operations_0|operation|strictness" value="0.8" /> | |
| 328 <output name="fastq_out" file="trimmomatic_maxinfo.fastq" /> | |
| 329 </test> | |
| 9 | 330 <test> |
| 331 <!-- Paired-end ILLUMINACLIP - this does not check valid clipping --> | |
| 332 <param name="single_or_paired" value="pair_of_files" /> | |
| 333 <param name="fastq_r1_in" value="Illumina_SG_R1.fastq" ftype="fastqsanger" /> | |
| 334 <param name="fastq_r2_in" value="Illumina_SG_R2.fastq" ftype="fastqsanger" /> | |
| 335 <param name="do_illuminaclip" value="true"/> | |
| 336 <param name="adapter_fasta" value="TruSeq2-PE.fa"/> | |
| 337 <param name="operations_0|operation|name" value="SLIDINGWINDOW" /> | |
| 338 <output name="fastq_out_r1_paired" file="trimmomatic_pe_r1_paired_out1_clip.fastq" /> | |
| 339 <output name="fastq_out_r1_unpaired" file="trimmomatic_pe_r1_unpaired_out1.fastq" /> | |
| 340 <output name="fastq_out_r2_paired" file="trimmomatic_pe_r2_paired_out1.fastq" /> | |
| 341 <output name="fastq_out_r2_unpaired" file="trimmomatic_pe_r2_unpaired_out1_clip.fastq" /> | |
| 342 </test> | |
| 343 <test> | |
| 344 <!-- Paired-end ILLUMINACLIP providing 'custom' adapters - this does not check valid clipping --> | |
| 345 <param name="single_or_paired" value="pair_of_files" /> | |
| 346 <param name="fastq_r1_in" value="Illumina_SG_R1.fastq" ftype="fastqsanger" /> | |
| 347 <param name="fastq_r2_in" value="Illumina_SG_R2.fastq" ftype="fastqsanger" /> | |
| 348 <param name="do_illuminaclip" value="true"/> | |
| 349 <param name="standard_or_custom" value="custom"/> | |
| 350 <param name="adapter_text" | |
| 351 value=">PrefixPE/1 AATGATACGGCGACCACCGAGATCTACACTCTTTCCCTACACGACGCTCTTCCGATCT >PrefixPE/2 CAAGCAGAAGACGGCATACGAGATCGGTCTCGGCATTCCTGCTGAACCGCTCTTCCGATCT >PCR_Primer1 AATGATACGGCGACCACCGAGATCTACACTCTTTCCCTACACGACGCTCTTCCGATCT >PCR_Primer1_rc AGATCGGAAGAGCGTCGTGTAGGGAAAGAGTGTAGATCTCGGTGGTCGCCGTATCATT >PCR_Primer2 CAAGCAGAAGACGGCATACGAGATCGGTCTCGGCATTCCTGCTGAACCGCTCTTCCGATCT >PCR_Primer2_rc AGATCGGAAGAGCGGTTCAGCAGGAATGCCGAGACCGATCTCGTATGCCGTCTTCTGCTTG >FlowCell1 TTTTTTTTTTAATGATACGGCGACCACCGAGATCTACAC >FlowCell2 TTTTTTTTTTCAAGCAGAAGACGGCATACGA "/> | |
| 352 <param name="adapter_fasta" value="TruSeq2-PE.fa"/> | |
| 353 <param name="operations_0|operation|name" value="SLIDINGWINDOW" /> | |
| 354 <output name="fastq_out_r1_paired" file="trimmomatic_pe_r1_paired_out1_clip.fastq" /> | |
| 355 <output name="fastq_out_r1_unpaired" file="trimmomatic_pe_r1_unpaired_out1.fastq" /> | |
| 356 <output name="fastq_out_r2_paired" file="trimmomatic_pe_r2_paired_out1.fastq" /> | |
| 357 <output name="fastq_out_r2_unpaired" file="trimmomatic_pe_r2_unpaired_out1_clip.fastq" /> | |
| 358 </test> | |
| 1 | 359 </tests> |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
360 <help><![CDATA[ |
| 1 | 361 .. class:: infomark |
| 362 | |
| 363 **What it does** | |
| 364 | |
| 365 Trimmomatic performs a variety of useful trimming tasks for illumina paired-end and | |
| 366 single ended data. | |
| 367 | |
| 368 This tool allows the following trimming steps to be performed: | |
| 369 | |
| 370 * **ILLUMINACLIP:** Cut adapter and other illumina-specific sequences from the read | |
| 9 | 371 |
| 372 * If **Always keep both reads (PE specific/palindrome mode)** is True, the reverse read will also be retained in palindrome mode. | |
| 373 After read-though has been detected by palindrome mode, and the adapter sequence removed, | |
| 374 the reverse read contains the same sequence information as the forward read, albeit in reverse complement. | |
| 375 For this reason, the default behaviour is to entirely drop the reverse read. | |
| 376 Retaining the reverse read may be useful e.g. if the downstream tools cannot handle a combination of paired and unpaired reads. | |
| 1 | 377 * **SLIDINGWINDOW:** Perform a sliding window trimming, cutting once the average |
| 378 quality within the window falls below a threshold | |
| 379 * **MINLEN:** Drop the read if it is below a specified length | |
| 380 * **LEADING:** Cut bases off the start of a read, if below a threshold quality | |
| 381 * **TRAILING:** Cut bases off the end of a read, if below a threshold quality | |
| 382 * **CROP:** Cut the read to a specified length | |
| 383 * **HEADCROP:** Cut the specified number of bases from the start of the read | |
| 4 | 384 * **AVGQUAL:** Drop the read if the average quality is below a specified value |
| 7 | 385 * **MAXINFO:** Trim reads adaptively, balancing read length and error rate to |
| 4 | 386 maximise the value of each read |
| 1 | 387 |
| 388 If ILLUMINACLIP is requested then it is always performed first; subsequent options | |
| 389 can be mixed and matched and will be performed in the order that they have been | |
| 390 specified. | |
| 391 | |
| 392 .. class:: warningmark | |
| 393 | |
| 394 Note that trimming operation order is important. | |
| 395 | |
| 396 ------------- | |
| 397 | |
| 398 .. class:: infomark | |
| 399 | |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
400 **Inputs** |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
401 |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
402 For single-end data this Trimmomatic tool accepts a single FASTQ file; for |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
403 paired-end data it will accept either two FASTQ files (R1 and R2), or a |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
404 dataset collection containing the R1/R2 FASTQ pair. |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
405 |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
406 .. class:: infomark |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
407 |
| 1 | 408 **Outputs** |
| 409 | |
| 410 For paired-end data a particular strength of Trimmomatic is that it retains the | |
| 411 pairing of reads (from R1 and R2) in the filtered output files: | |
| 412 | |
| 413 * Two FASTQ files (R1-paired and R2-paired) contain one read from each pair where | |
| 414 both have survived filtering. | |
| 415 * Additionally two FASTQ files (R1-unpaired and R2-unpaired) contain reads where | |
| 416 one of the pair failed the filtering steps. | |
| 417 | |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
418 .. class:: warningmark |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
419 |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
420 If the input consists of a dataset collection with the R1/R2 FASTQ pair then |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
421 the outputs will also inclue two dataset collections: one for the 'paired' |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
422 outputs and one for the 'unpaired' (as described above) |
|
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
423 |
| 1 | 424 Retaining the same order and number of reads in the filtered output fastq files is |
| 425 essential for many downstream analysis tools. | |
| 426 | |
| 427 For single-end data the output is a single FASTQ file containing just the filtered | |
| 428 reads. | |
| 429 | |
| 430 ------------- | |
| 431 | |
| 432 .. class:: infomark | |
| 433 | |
| 434 **Credits** | |
| 435 | |
| 436 This Galaxy tool has been developed within the Bioinformatics Core Facility at the | |
| 9 | 437 University of Manchester, with contributions from Peter van Heusden, Marius |
| 438 van den Beek, Jelle Scholtalbers and Charles Girardot. | |
| 7 | 439 |
| 440 It runs the Trimmomatic program which has been developed | |
| 1 | 441 within Bjorn Usadel's group at RWTH Aachen university. |
| 442 | |
| 443 Trimmomatic website (including documentation): | |
| 444 | |
| 7 | 445 * http://www.usadellab.org/cms/index.php?page=trimmomatic |
| 1 | 446 |
| 447 The reference for Trimmomatic is: | |
| 448 | |
| 449 * Bolger, A.M., Lohse, M., & Usadel, B. (2014). Trimmomatic: A flexible trimmer | |
| 450 for Illumina Sequence Data. Bioinformatics, btu170. | |
| 451 | |
| 452 Please kindly acknowledge both this Galaxy tool and the Trimmomatic program if you | |
| 453 use it. | |
|
3
a7139c612c45
Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents:
2
diff
changeset
|
454 ]]></help> |
| 1 | 455 <citations> |
| 456 <!-- | |
| 457 See https://wiki.galaxyproject.org/Admin/Tools/ToolConfigSyntax#A.3Ccitations.3E_tag_set | |
| 458 Can be either DOI or Bibtex | |
| 459 Use http://www.bioinformatics.org/texmed/ to convert PubMed to Bibtex | |
| 460 --> | |
| 461 <citation type="doi">10.1093/bioinformatics/btu170</citation> | |
| 462 </citations> | |
| 463 </tool> |