comparison cutadapt.xml @ 10:01d94df2e32a draft

planemo upload for repository https://bitbucket.org/lance_parsons/cutadapt_galaxy_wrapper
author lparsons
date Tue, 26 May 2015 16:02:19 -0400
parents 93d58ffe39f1
children 8665bcc8b847
comparison
equal deleted inserted replaced
9:93d58ffe39f1 10:01d94df2e32a
1 <tool id="cutadapt" name="Cutadapt" version="1.6"> 1 <tool id="cutadapt" name="Cutadapt" version="1.6">
2 <description>Remove adapter sequences from Fastq/Fasta</description> 2 <description>Remove adapter sequences from Fastq/Fasta</description>
3 <requirements> 3 <requirements>
4 <requirement type="package" version="1.6">cutadapt</requirement> 4 <requirement type="package" version="1.6">cutadapt</requirement>
5 </requirements> 5 </requirements>
6
7 <stdio>
8 <exit_code range="1" level="fatal" description="IOError, FormatError, or Interrupt" />
9 <exit_code range="2" level="fatal" description="Invalid options specified" />
10 <exit_code range="3:" level="fatal" description="Unknown error" />
11 </stdio>
12
6 <version_command>cutadapt --version</version_command> 13 <version_command>cutadapt --version</version_command>
7 14
8 <command>cutadapt 15 <command>cutadapt
9 #if $input.extension.startswith( "fastq"): 16 #if $input.extension.startswith( "fastq"):
10 --format=fastq 17 --format=fastq
119 '$input2' 126 '$input2'
120 #end if 127 #end if
121 128
122 > $report 129 > $report
123 </command> 130 </command>
131
124 <inputs> 132 <inputs>
125 <param format="fastq, fastqsanger, fastqillumina, fastqsolexa, fasta" name="input" type="data" optional="false" label="Fastq file to trim" length="100"/> 133 <param format="fastq, fastqsanger, fastqillumina, fastqsolexa, fasta" name="input" type="data" optional="false" label="Fastq file to trim" length="100"/>
126 <conditional name="paired_end"> 134 <conditional name="paired_end">
127 <param name="paired_end_boolean" type="boolean" value="false" label="Track Paired Reads" help="This option will keep a second file synchronized if you use one of the filtering options that discards reads. It will NOT trim adapters off of the second read. You must run Cutadapt a second time on the output of the first run to trim adapters from both reads (see Cutadapt documentation for details)." /> 135 <param name="paired_end_boolean" type="boolean" value="false" label="Track Paired Reads" help="This option will keep a second file synchronized if you use one of the filtering options that discards reads. It will NOT trim adapters off of the second read. You must run Cutadapt a second time on the output of the first run to trim adapters from both reads (see Cutadapt documentation for details)." />
128 <when value="true"> 136 <when value="true">
129 <param format="fastq, fastqsanger, fastqillumina, fastqsolexa, fasta" name="input2" type="data" optional="false" label="Paired fastq file (NOT trimmed)" length="100"/> 137 <param format="fastq, fastqsanger, fastqillumina, fastqsolexa, fasta" name="input2" type="data" optional="false" label="Paired fastq file (NOT trimmed)" length="100"/>
130 </when> 138 </when>
139 <when value="false" />
131 </conditional> 140 </conditional>
132 141
133 <repeat name="adapters" title="3' Adapters" help="Sequence of an adapter that was ligated to the 3' end. The adapter itself and anything that follows is trimmed."> 142 <repeat name="adapters" title="3' Adapters" help="Sequence of an adapter that was ligated to the 3' end. The adapter itself and anything that follows is trimmed.">
134 <conditional name="adapter_source"> 143 <conditional name="adapter_source">
135 <param name="adapter_source_list" type="select" label="Source" > 144 <param name="adapter_source_list" type="select" label="Source" >
253 </conditional> 262 </conditional>
254 </inputs> 263 </inputs>
255 264
256 <outputs> 265 <outputs>
257 <data format="txt" name="report" label="${tool.name} on ${on_string} (Report)" /> 266 <data format="txt" name="report" label="${tool.name} on ${on_string} (Report)" />
258 <data format="input" name="output" metadata_source="input" label="${tool.name} on ${on_string} (Reads)"/> 267 <data format_source="input" name="output" metadata_source="input" label="${tool.name} on ${on_string} (Reads)"/>
259 <data format="input" name="paired_output" metadata_source="input" label="${tool.name} on ${on_string} (Paired Reads)" > 268 <data format_source="input" name="paired_output" metadata_source="input" label="${tool.name} on ${on_string} (Paired Reads)" >
260 <filter>(paired_end['paired_end_boolean'] is True)</filter> 269 <filter>(paired_end['paired_end_boolean'] is True)</filter>
261 </data> 270 </data>
262 <data format="input" name="rest_output" metadata_source="input" label="${tool.name} on ${on_string} (Rest of Reads)" > 271 <data format_source="input" name="rest_output" metadata_source="input" label="${tool.name} on ${on_string} (Rest of Reads)" >
263 <filter>(output_params['output_type'] == "additional")</filter> 272 <filter>(output_params['output_type'] == "additional")</filter>
264 <filter>(output_params['rest_file'] is True)</filter> 273 <filter>(output_params['rest_file'] is True)</filter>
265 </data> 274 </data>
266 <data format="txt" name="wild_output" metadata_source="input" label="${tool.name} on ${on_string} (Wildcard File)" > 275 <data format_source="txt" name="wild_output" metadata_source="input" label="${tool.name} on ${on_string} (Wildcard File)" >
267 <filter>(output_params['output_type'] == "additional")</filter> 276 <filter>(output_params['output_type'] == "additional")</filter>
268 <filter>(output_params['wildcard_file'] is True)</filter> 277 <filter>(output_params['wildcard_file'] is True)</filter>
269 </data> 278 </data>
270 <data format="input" name="too_short_output" metadata_source="input" label="${tool.name} on ${on_string} (Too Short Reads)" > 279 <data format_source="input" name="too_short_output" metadata_source="input" label="${tool.name} on ${on_string} (Too Short Reads)" >
271 <filter>(output_params['output_type'] == "additional")</filter> 280 <filter>(output_params['output_type'] == "additional")</filter>
272 <filter>(output_params['too_short_file'] is True)</filter> 281 <filter>(output_params['too_short_file'] is True)</filter>
273 </data> 282 </data>
274 <data format="input" name="too_long_output" metadata_source="input" label="${tool.name} on ${on_string} (Too Long Reads)" > 283 <data format_source="input" name="too_long_output" metadata_source="input" label="${tool.name} on ${on_string} (Too Long Reads)" >
275 <filter>(output_params['output_type'] == "additional")</filter> 284 <filter>(output_params['output_type'] == "additional")</filter>
276 <filter>(output_params['too_long_file'] is True)</filter> 285 <filter>(output_params['too_long_file'] is True)</filter>
277 </data> 286 </data>
278 <data format="input" name="untrimmed_output" metadata_source="input" label="${tool.name} on ${on_string} (Untrimmed Reads)" > 287 <data format_source="input" name="untrimmed_output" metadata_source="input" label="${tool.name} on ${on_string} (Untrimmed Reads)" >
279 <filter>(output_params['output_type'] == "additional")</filter> 288 <filter>(output_params['output_type'] == "additional")</filter>
280 <filter>(output_params['untrimmed_file'] is True)</filter> 289 <filter>(output_params['untrimmed_file'] is True)</filter>
281 </data> 290 </data>
282 <data format="input" name="untrimmed_paired_output" metadata_source="input" label="${tool.name} on ${on_string} (Untrimmed Paired Reads)" > 291 <data format_source="input" name="untrimmed_paired_output" metadata_source="input" label="${tool.name} on ${on_string} (Untrimmed Paired Reads)" >
283 <filter>(paired_end['paired_end_boolean'] is True)</filter> 292 <filter>(paired_end['paired_end_boolean'] is True)</filter>
284 <filter>(output_params['output_type'] == "additional")</filter> 293 <filter>(output_params['output_type'] == "additional")</filter>
285 <filter>(output_params['untrimmed_file'] is True)</filter> 294 <filter>(output_params['untrimmed_file'] is True)</filter>
286 </data> 295 </data>
287 <data format="txt" name="info_file" metadata_source="input" label="${tool.name} on ${on_string} (Info File)" > 296 <data format_source="txt" name="info_file" metadata_source="input" label="${tool.name} on ${on_string} (Info File)" >
288 <filter>(output_params['output_type'] == "additional")</filter> 297 <filter>(output_params['output_type'] == "additional")</filter>
289 <filter>(output_params['info_file'] is True)</filter> 298 <filter>(output_params['info_file'] is True)</filter>
290 </data> 299 </data>
291 </outputs> 300 </outputs>
292
293 <stdio>
294 <exit_code range="1" level="fatal" description="IOError, FormatError, or Interrupt" />
295 <exit_code range="2" level="fatal" description="Invalid options specified" />
296 <exit_code range="3:" level="fatal" description="Unknown error" />
297 </stdio>
298 301
299 <tests> 302 <tests>
300 <test> 303 <test>
301 <param name="input" value="cutadapt_small.fastq" ftype="fastqsanger"/> 304 <param name="input" value="cutadapt_small.fastq" ftype="fastqsanger"/>
302 <param name="adapter_source_list" value="user"/>
303 <param name="adapter" value=""/>
304 <param name="anywhere_adapter_source_list" value="user"/> 305 <param name="anywhere_adapter_source_list" value="user"/>
305 <param name="anywhere_adapter" value="TTAGACATATCTCCGTCG"/> 306 <param name="anywhere_adapter" value="TTAGACATATCTCCGTCG"/>
306 <param name="front_adapter_source_list" value="user"/>
307 <param name="front_adapter" value=""/>
308 <param name="output_filtering" value="default"/> 307 <param name="output_filtering" value="default"/>
309 <param name="read_modification" value="none"/> 308 <param name="read_modification" value="none"/>
310 <param name="output_type" value="default"/> 309 <param name="output_type" value="default"/>
311 <output name="output" file="cutadapt_small.out"/> 310 <output name="output" file="cutadapt_small.out"/>
312 </test> 311 </test>
313 <!-- Unable to get tests to function with conditional parameters
314 <test> 312 <test>
315 <param name="input" value="cutadapt_small.fastq" ftype="fastqsanger"/> 313 <param name="input" value="cutadapt_small.fastq" ftype="fastqsanger"/>
316 <param name="adapter_source_list" value="user"/> 314 <param name="adapter_source_list" value="user"/>
317 <param name="adapter" value="TTAGACATATCTCCGTCG"/> 315 <param name="adapter" value="TTAGACATATCTCCGTCG"/>
318 <param name="anywhere_adapter_source_list" value="user"/>
319 <param name="anywhere_adapter" value=""/>
320 <param name="front_adapter_source_list" value="user"/>
321 <param name="front_adapter" value=""/>
322 <param name="output_filtering" value="filter"/> 316 <param name="output_filtering" value="filter"/>
323 <param name="discard" value="true"/> 317 <param name="discard" value="true"/>
324 <param name="read_modification" value="none"/> 318 <param name="read_modification" value="none"/>
325 <param name="output_type" value="default"/> 319 <param name="output_type" value="default"/>
326 <output name="output" file="cutadapt_discard.out"/> 320 <output name="output" file="cutadapt_discard.out"/>
327 </test> 321 </test>
328 <test> 322 <test>
329 <param name="input" value="cutadapt_rest.fa" ftype="fasta"/> 323 <param name="input" value="cutadapt_rest.fa" ftype="fasta"/>
330 <param name="adapter_source_list" value="user"/> 324 <param name="adapter_source_list" value="user"/>
331 <param name="adapter" value="ADAPTER"/> 325 <param name="adapter" value="ADAPTER"/>
332 <param name="anywhere_adapter_source_list" value="user"/>
333 <param name="anywhere_adapter" value=""/>
334 <param name="front_adapter_source_list" value="user"/>
335 <param name="front_adapter" value=""/>
336 <param name="output_filtering" value="default"/> 326 <param name="output_filtering" value="default"/>
337 <param name="read_modification" value="none"/> 327 <param name="read_modification" value="none"/>
338 <param name="output_type" value="additional"/> 328 <param name="output_type" value="additional"/>
339 <param name="rest_file" value="true"/> 329 <param name="rest_file" value="true"/>
340 <output name="output" file="cutadapt_rest.out"/> 330 <output name="output" file="cutadapt_rest.out"/>
341 <output name="rest_output" file="cutadapt_rest2.out"/> 331 <output name="rest_output" file="cutadapt_rest2.out"/>
342 </test> 332 </test>
343 -->
344 </tests> 333 </tests>
345 334
346 <help> 335 <help>
347 Summary 336 Summary
348 ------- 337 -------
467 When parsing that file, be aware that additional columns may be added in the future. Note also that some fields can be empty, resulting in consecutive tabs within a line. Also, in the current version, when the *Match times* option is set to a value other than 1 (the default value), multiple lines are written to the info file for each read. 456 When parsing that file, be aware that additional columns may be added in the future. Note also that some fields can be empty, resulting in consecutive tabs within a line. Also, in the current version, when the *Match times* option is set to a value other than 1 (the default value), multiple lines are written to the info file for each read.
468 457
469 .. _cutadapt: http://code.google.com/p/cutadapt/ 458 .. _cutadapt: http://code.google.com/p/cutadapt/
470 </help> 459 </help>
471 460
461 <citations>
462 <citation type="bibtex">
463 @article{marcel_cutadapt_2011,
464 title = {Cutadapt removes adapter sequences from high-throughput sequencing reads},
465 volume = {17},
466 copyright = {Authors who publish with this journal agree to the following terms: Authors retain copyright and grant the journal right of first publication with the work simultaneously licensed under a Creative Commons Attribution License that allows others to share the work with an acknowledgement of the work's authorship and initial publication in this journal. Authors are able to enter into separate, additional contractual arrangements for the non-exclusive distribution of the journal's published version of the work (e.g., post it to an institutional repository or publish it in a book), with an acknowledgement of its initial publication in this journal. Authors are permitted and encouraged to post their work online (e.g., in institutional repositories or on their website) prior to and during the submission process, as it can lead to productive exchanges, as well as earlier and greater citation of published work (See The Effect of Open Access ).},
467 url = {http://journal.embnet.org/index.php/embnetjournal/article/view/200},
468 abstract = {When small RNA is sequenced on current sequencing machines, the resulting reads are usually longer than the RNA and therefore contain parts of the 3' adapter. That adapter must be found and removed error-tolerantly from each read before read mapping. Previous solutions are either hard to use or do not offer required features, in particular support for color space data. As an easy to use alternative, we developed the command-line tool cutadapt, which supports 454, Illumina and SOLiD (color space) data, offers two adapter trimming algorithms, and has other useful features.
469
470 Cutadapt, including its MIT-licensed source code, is available for download at http://code.google.com/p/cutadapt/},
471 number = {1},
472 urldate = {2011-08-02},
473 journal = {EMBnet.journal},
474 author = {Marcel, Martin},
475 year = {2011},
476 note = {When small RNA is sequenced on current sequencing machines, the resulting reads are usually longer than the RNA and therefore contain parts of the 3' adapter. That adapter must be found and removed error-tolerantly from each read before read mapping. Previous solutions are either hard to use or do not offer required features, in particular support for color space data. As an easy to use alternative, we developed the command-line tool cutadapt, which supports 454, Illumina and SOLiD (color space) data, offers two adapter trimming algorithms, and has other useful features. Cutadapt, including its MIT-licensed source code, is available for download at http://code.google.com/p/cutadapt/},
477 keywords = {Adapter removal;, fastq, MicroRNA, Sequencing, Small RNA, software},
478 file = {Cutadapt removes adapter sequences from high-throughput sequencing reads | Martin | EMBnet.journal:/Users/lparsons/Library/Application Support/Firefox/Profiles/thd2t4je.default/zotero/storage/ZXZT4PSE/200.html:text/html}
479 }
480 </citation>
481 </citations>
482
472 </tool> 483 </tool>