comparison trim_galore.xml @ 11:80cd83b11214 draft

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/trim_galore commit 78bee2b2efd36fe9399ce574159fc007cb6bdfbf
author bgruening
date Mon, 24 Apr 2017 14:30:07 -0400
parents b4e39d993fc8
children 1bf4789584dc
comparison
equal deleted inserted replaced
10:b4e39d993fc8 11:80cd83b11214
1 <tool id="trim_galore" name="Trim Galore!" version="0.4.3" profile="17.01"> 1 <tool id="trim_galore" name="Trim Galore!" version="0.4.3.0" profile="17.01">
2 <!-- Wrapper compatible with Trim Galore! version 0.4 --> 2 <!-- Wrapper compatible with Trim Galore! version 0.4.3 -->
3 <description>Quality and adapter trimmer of reads</description> 3 <description>Quality and adapter trimmer of reads</description>
4 <macros> 4 <macros>
5 <macro name="adapter_trimming"> 5 <macro name="adapter_trimming">
6 <conditional name="trimming"> 6 <conditional name="trimming">
7 <param name="trimming_select" type="select" label="Adapter sequence to be trimmed"> 7 <param name="trimming_select" type="select" label="Adapter sequence to be trimmed">
22 <yield/> 22 <yield/>
23 </when> 23 </when>
24 </conditional> 24 </conditional>
25 </macro> 25 </macro>
26 <macro name="paired_adapter_trimming"> 26 <macro name="paired_adapter_trimming">
27
28 <expand macro="adapter_trimming"> 27 <expand macro="adapter_trimming">
29 <param name="adapter2" type="text" optional="True" value="" label="Adapter sequence to be trimmed off read 2"> 28 <param name="adapter2" type="text" optional="True" value="" label="Adapter sequence to be trimmed off read 2">
30 <validator type="regex" message="Adapter sequence must contain DNA characters only (A,C,T,G or N)">^[ACTGNactgn]*$</validator> 29 <validator type="regex" message="Adapter sequence must contain DNA characters only (A,C,T,G or N)">^[ACTGNactgn]*$</validator>
31 </param> 30 </param>
32 </expand> 31 </expand>
42 the 3' end that is not directly related to adapter sequence or basecall quality.</help> 41 the 3' end that is not directly related to adapter sequence or basecall quality.</help>
43 </param> 42 </param>
44 </macro> 43 </macro>
45 </macros> 44 </macros>
46 <requirements> 45 <requirements>
47 <!-- conda dependency --> 46 <requirement type="package" version="0.4.3">trim-galore</requirement>
48 <requirement type="package" version="1.8.3">cutadapt</requirement>
49 <requirement type="package" version="1.8">cutadapt</requirement>
50 </requirements> 47 </requirements>
51 <version_command> 48 <version_command>
52 perl '$__tool_directory__/trim_galore' --version 49 trim_galore --version
53 </version_command> 50 </version_command>
54 <command> 51 <command><![CDATA[
55 <![CDATA[
56
57 #set compressed = 'no' 52 #set compressed = 'no'
58 #if $singlePaired.sPaired == "single": 53 #if $singlePaired.sPaired == "single":
59 #if $singlePaired.input_singles.is_of_type("fastq.gz"): 54 #if $singlePaired.input_singles.is_of_type("fastq.gz"):
60 #set read1 = 'input_1.fastq.gz' 55 #set read1 = 'input_1.fastq.gz'
61 #set compressed = 'gz' 56 #set compressed = 'gz'
93 #set read2 = 'input_2.fastq' 88 #set read2 = 'input_2.fastq'
94 #end if 89 #end if
95 ln -s '${singlePaired.input_mate_pairs.reverse}' ${read2} && 90 ln -s '${singlePaired.input_mate_pairs.reverse}' ${read2} &&
96 #end if 91 #end if
97 92
98 perl '$__tool_directory__/trim_galore' 93 trim_galore
99 94
100 ## we only support fastqsanger 95 ## we only support fastqsanger
101 --phred33 96 --phred33
102 97
103 #if $params.settingsType == "custom": 98 #if $params.settingsType == "custom":
144 #end if 139 #end if
145 140
146 #if $singlePaired.trimming.trimming_select == 'user': 141 #if $singlePaired.trimming.trimming_select == 'user':
147 ## default 'AGATCGGAAGAGC' 142 ## default 'AGATCGGAAGAGC'
148 #if $singlePaired.trimming.adapter.strip() != '': 143 #if $singlePaired.trimming.adapter.strip() != '':
149 --adapter $singlePaired.trimming.adapter 144 --adapter '$singlePaired.trimming.adapter'
150 #end if 145 #end if
151 #else: 146 #else:
152 $singlePaired.trimming.trimming_select 147 $singlePaired.trimming.trimming_select
153 #end if 148 #end if
154
155 149
156 #if $singlePaired.three_prime_clip_R1: 150 #if $singlePaired.three_prime_clip_R1:
157 --three_prime_clip_R1 $singlePaired.three_prime_clip_R1 151 --three_prime_clip_R1 $singlePaired.three_prime_clip_R1
158 #end if 152 #end if
159 153
165 159
166 $singlePaired.trim1 160 $singlePaired.trim1
167 161
168 #if $singlePaired.trimming.trimming_select == 'user': 162 #if $singlePaired.trimming.trimming_select == 'user':
169 #if $singlePaired.trimming.adapter2 and $singlePaired.trimming.adapter2.strip() != '': 163 #if $singlePaired.trimming.adapter2 and $singlePaired.trimming.adapter2.strip() != '':
170 --adapter2 $singlePaired.trimming.adapter2 164 --adapter2 '$singlePaired.trimming.adapter2'
171 #end if 165 #end if
172 #end if 166 #end if
173 167
174 #if $singlePaired.three_prime_clip_R2: 168 #if $singlePaired.three_prime_clip_R2:
175 --three_prime_clip_R2 $singlePaired.three_prime_clip_R2 169 --three_prime_clip_R2 $singlePaired.three_prime_clip_R2
197 if [ -f input_2_unpaired_2.fq.gz ] ; then mv input_2_unpaired_2.fq.gz input_2_unpaired_2.fq ; fi 191 if [ -f input_2_unpaired_2.fq.gz ] ; then mv input_2_unpaired_2.fq.gz input_2_unpaired_2.fq ; fi
198 192
199 ## Trim Galore! run is finished. Move the report files to the proper place 193 ## Trim Galore! run is finished. Move the report files to the proper place
200 #if $params.settingsType == "custom" and $params.report: 194 #if $params.settingsType == "custom" and $params.report:
201 && 195 &&
202 cat ./*_trimming_report.txt > $report_file; 196 cat ./*_trimming_report.txt > '$report_file'
203 #end if 197 #end if
204 198 ]]></command>
205 ]]>
206 </command>
207 <inputs> 199 <inputs>
208 <!-- Input Parameters --> 200 <!-- Input Parameters -->
209 <conditional name="singlePaired"> 201 <conditional name="singlePaired">
210 <param name="sPaired" type="select" label="Is this library paired- or single-end?"> 202 <param name="sPaired" type="select" label="Is this library paired- or single-end?">
211 <option value="single">Single-end</option> 203 <option value="single">Single-end</option>
281 label="Specifies that the input file was an MspI digested RRBS sample" /> 273 label="Specifies that the input file was an MspI digested RRBS sample" />
282 <param name="non_directional" type="boolean" truevalue="--non_directional" falsevalue="" checked="False" 274 <param name="non_directional" type="boolean" truevalue="--non_directional" falsevalue="" checked="False"
283 label="Screen quality-trimmed sequences for 'CAA' or 'CGA' at the start of the read and, if found, removes the first two basepairs" /> 275 label="Screen quality-trimmed sequences for 'CAA' or 'CGA' at the start of the read and, if found, removes the first two basepairs" />
284 </when> <!-- full --> 276 </when> <!-- full -->
285 </conditional> <!-- params --> 277 </conditional> <!-- params -->
286
287 </inputs> 278 </inputs>
279
288 <outputs> 280 <outputs>
289 <data format_source="input_singles" name="trimmed_reads_single" from_work_dir="input_1_trimmed.fq" label="${tool.name} on ${on_string}: trimmed reads"> 281 <data format_source="input_singles" name="trimmed_reads_single" from_work_dir="input_1_trimmed.fq" label="${tool.name} on ${on_string}: trimmed reads">
290 <filter>singlePaired['sPaired'] == "single"</filter> 282 <filter>singlePaired['sPaired'] == "single"</filter>
291 </data> 283 </data>
292 284
329 </data> 321 </data>
330 <data format="txt" name="report_file" label="${tool.name} on ${on_string}: report file"> 322 <data format="txt" name="report_file" label="${tool.name} on ${on_string}: report file">
331 <filter>params['settingsType'] == "custom"</filter> 323 <filter>params['settingsType'] == "custom"</filter>
332 <filter>params['report'] == True</filter> 324 <filter>params['report'] == True</filter>
333 </data> 325 </data>
334
335 </outputs> 326 </outputs>
327
336 <tests> 328 <tests>
337 <test> 329 <test>
338 <param name="input_singles" value="sanger_full_range_original_sanger.fastqsanger" ftype="fastqsanger" /> 330 <param name="input_singles" value="sanger_full_range_original_sanger.fastqsanger" ftype="fastqsanger" />
339 <param name="sPaired" value="single" /> 331 <param name="sPaired" value="single" />
340 <param name="settingsType" value="custom" /> 332 <param name="settingsType" value="custom" />
447 <element name="forward" file="paired_collection_example_unpair1_results3.fastq.gz" ftype="fastqsanger.gz" compare="sim_size" delta="0"/> 439 <element name="forward" file="paired_collection_example_unpair1_results3.fastq.gz" ftype="fastqsanger.gz" compare="sim_size" delta="0"/>
448 <element name="reverse" file="paired_collection_example_unpair2_results3.fastq.gz" ftype="fastqsanger.gz" compare="sim_size" delta="0"/> 440 <element name="reverse" file="paired_collection_example_unpair2_results3.fastq.gz" ftype="fastqsanger.gz" compare="sim_size" delta="0"/>
449 </output_collection> 441 </output_collection>
450 </test> 442 </test>
451 </tests> 443 </tests>
452 <help> 444 <help><![CDATA[
453 <![CDATA[
454 **What it does** 445 **What it does**
455 446
456 `Trim Galore!`_ is a wrapper script to automate quality and adapter trimming as well as quality control, with some added functionality to remove biased methylation positions for RRBS sequence files (for directional, non-directional (or paired-end) sequencing). It's main features are: 447 `Trim Galore!`_ is a wrapper script to automate quality and adapter trimming as well as quality control, with some added functionality to remove biased methylation positions for RRBS sequence files (for directional, non-directional (or paired-end) sequencing). It's main features are:
457 448
458 * For adapter trimming, Trim Galore! uses the first 13 bp of Illumina standard adapters ('AGATCGGAAGAGC') by default (suitable for both ends of paired-end libraries), but accepts other adapter sequence, too 449 * For adapter trimming, Trim Galore! uses the first 13 bp of Illumina standard adapters ('AGATCGGAAGAGC') by default (suitable for both ends of paired-end libraries), but accepts other adapter sequence, too
471 **Main Settings** 462 **Main Settings**
472 463
473 * **Adapter sequence to be trimmed** 464 * **Adapter sequence to be trimmed**
474 465
475 * **Automatic detection** 466 * **Automatic detection**
476 467
477 | Adapter sequence to be trimmed. Trim Galore will try to auto-detect whether the Illumina universal, Nextera transposase or Illumina small RNA adapter sequence was used. 468 | Adapter sequence to be trimmed. Trim Galore will try to auto-detect whether the Illumina universal, Nextera transposase or Illumina small RNA adapter sequence was used.
478 469
479 * **Illumina universal** 470 * **Illumina universal**
480 471
481 | Adapter sequence to be trimmed is the first 13bp of the Illumina universal adapter 'AGATCGGAAGAGC' instead of the default auto-detection of adapter sequence. 472 | Adapter sequence to be trimmed is the first 13bp of the Illumina universal adapter 'AGATCGGAAGAGC' instead of the default auto-detection of adapter sequence.
516 | 507 |
517 | R1 ---------------------------> 508 | R1 --------------------------->
518 | R2 <--------------------------- 509 | R2 <---------------------------
519 | 510 |
520 | or this: 511 | or this:
521 | 512 |
522 | R1 -----------------------> 513 | R1 ----------------------->
523 | R2 <----------------- 514 | R2 <-----------------
524 | 515 |
525 | as invalid (whenever a start/end coordinate is contained within the other read). 516 | as invalid (whenever a start/end coordinate is contained within the other read).
526 | 517 |
598 589
599 * **Screen quality-trimmed sequences for 'CAA' or 'CGA' at the start of the read and, if found, removes the first two basepairs** 590 * **Screen quality-trimmed sequences for 'CAA' or 'CGA' at the start of the read and, if found, removes the first two basepairs**
600 591
601 | Selecting this option for non-directional RRBS libraries will screen quality-trimmed sequences for 'CAA' or 'CGA' at the start of the read and, if found, removes the first two basepairs. Like with the option '--rrbs' this avoids using cytosine positions that were filled-in during the end-repair step. '--non_directional' requires '--rrbs' to be specified as well. 592 | Selecting this option for non-directional RRBS libraries will screen quality-trimmed sequences for 'CAA' or 'CGA' at the start of the read and, if found, removes the first two basepairs. Like with the option '--rrbs' this avoids using cytosine positions that were filled-in during the end-repair step. '--non_directional' requires '--rrbs' to be specified as well.
602 | 593 |
603 | *option --non_directional*]]> 594 | *option --non_directional*
604 </help> 595 ]]></help>
605 <citations></citations> 596 <citations></citations>
606 </tool> 597 </tool>