annotate fgbio_trim_fastq.xml @ 0:604d9b0ad9a4 draft default tip

"planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
author jjohnson
date Thu, 19 Aug 2021 15:13:17 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
1 <tool id="fgbio_trim_fastq" name="fgbio TrimFastq" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" python_template_version="3.5">
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
2 <description>Sorts the records in a FASTQ file based on the lexicographic ordering of their read names</description>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
3 <macros>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
4 <import>macros.xml</import>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
5 </macros>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
6 <expand macro="requirements" />
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
7 <version_command>fgbio --version</version_command>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
9 fgbio TrimFastq
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
10 --input '$input'
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
11 #if $fastq_input.fastq_input_selector == 'single':
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
12 '$fastq_input.input_single'
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
13 #elif $fastq_input.fastq_input_selector == 'paired':
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
14 '$fastq_input.input_read1'
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
15 '$fastq_input.input_read2'
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
16 #elif $fastq_input.fastq_input_selector == 'paired_collection':
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
17 '$fastq_input.input_readpair.forward'
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
18 '$fastq_input.input_readpair.reverse'
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
19 #end if
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
20 --length=$length
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
21 --exclude=$exclude
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
22 ]]></command>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
23 <inputs>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
24 <conditional name="fastq_input">
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
25 <param name="fastq_input_selector" type="select" label="Single or Paired-end reads" help="Select between paired and single end fastq files">
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
26 <option value="paired">Paired</option>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
27 <option value="single">Single</option>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
28 <option value="paired_collection">Paired Collection</option>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
29 </param>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
30 <when value="paired">
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
31 <param name="fastq_input1" type="data" format="fastqsanger,fastqsanger.gz,fasta" label="Select first set of reads" help="Specify dataset with forward reads"/>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
32 <param name="fastq_input2" type="data" format="fastqsanger,fastqsanger.gz,fasta" label="Select second set of reads" help="Specify dataset with reverse reads"/>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
33 </when>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
34 <when value="single">
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
35 <param name="fastq_input1" type="data" format="fastqsanger,fastqsanger.gz,fasta" label="Select fastq dataset" help="Specify dataset with single reads"/>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
36 </when>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
37 <when value="paired_collection">
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
38 <param name="fastq_input1" format="fastqsanger,fastqsanger.gz,fasta" type="data_collection" collection_type="paired" label="Select a paired collection" help="See help section for an explanation of dataset collections"/>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
39 </when>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
40 </conditional>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
41 <param argument="--length" type="integer" value="50" min="1" label="Length to trim reads to"/>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
42 <param argument="--exclude" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Exclude reads below the trim length"/>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
43 </inputs>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
44 <outputs>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
45 <data name="output1" format_source="input" label="Trimed ${input.name}"/>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
46 <data name="output2" format_source="input" label="Trimed ${input.name}"/>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
47 <data name="out1" format="fastqsanger" metadata_source="input_1" from_work_dir="out1*" label="${tool.name} on ${on_string}: Read 1 Output">
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
48 <filter>(output_options['multiple_output'] is False)</filter>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
49 <expand macro="inherit_format_1" />
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
50 </data>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
51 <data name="out2" format="fastqsanger" metadata_source="input_2" from_work_dir="out2*" label="${tool.name} on ${on_string}: Read 2 Output" >
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
52 <filter>(library['type'] == 'paired' or library['type'] == 'paired_collection')</filter>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
53 <expand macro="inherit_format_2" />
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
54 </data>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
55 </outputs>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
56 <help><![CDATA[
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
57 **fgbio TrimFastq**
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
58
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
59 Trims reads in one or more line-matched fastq files to a specific read length. The individual fastq files are expected to have the same set of reads, as would be the case with an r1.fastq and r2.fastq file for the same sample.
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
60
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
61 Optionally supports dropping of reads across all files when one or more reads is already shorter than the desired trim length.
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
62
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
63
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
64
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
65 http://fulcrumgenomics.github.io/fgbio/tools/latest/TrimFastq.html
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
66 ]]></help>
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
67 <expand macro="citations" />
604d9b0ad9a4 "planemo upload commit 77a5370a0978b5332bb3a9f063588a52a468ea08"
jjohnson
parents:
diff changeset
68 </tool>