annotate usearch_fastq_mergepairs.xml @ 28:dcad0a24bafa draft

Uploaded
author serranop
date Sat, 14 Sep 2013 12:20:18 -0400
parents 4c11ec2ae1c0
children 29cb532fc1ee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
861744133340 Increment version to 0.0.2
serranop
parents: 17
diff changeset
1 <tool id="usearch_fastq_mergepairs" name="usearch fastq_mergepairs" version="0.0.2">
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
2 <description>merging of paired reads</description>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
3 <version_command>usearch -version</version_command>
12
eec0db6ca419 View command
serranop
parents: 11
diff changeset
4 <command interpreter='bash'>usearch_wrapper.sh
eec0db6ca419 View command
serranop
parents: 11
diff changeset
5 usearch
eec0db6ca419 View command
serranop
parents: 11
diff changeset
6 -quiet
7
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
7 -fastq_mergepairs '$input_forward'
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
8 -reverse '$input_reverse'
17
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
9 #if $minovlen.value != 0
13
serranop
parents: 12
diff changeset
10 -fastq_minovlen $minovlen
7
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
11 #end if
22
8aae82cf927b More testing
serranop
parents: 21
diff changeset
12 #if $minmergelen.value != 0
8aae82cf927b More testing
serranop
parents: 21
diff changeset
13 -fastq_minmergelen $minmergelen
8aae82cf927b More testing
serranop
parents: 21
diff changeset
14 #end if
24
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
15 #if $maxmergelen.value != 0
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
16 -fastq_maxmergelen $maxmergelen
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
17 #end if
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
18 #if $maxdiffs.value != 0
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
19 -fastq_maxdiffs $maxdiffs
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
20 #end if
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
21 #if $truncqual.value != 0
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
22 -fastq_truncqual $truncqual
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
23 #end if
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
24 #if $minlen.value != 0
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
25 -fastq_minlen $minlen
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
26 #end if
25
26ab91de7593 Uploaded
serranop
parents: 24
diff changeset
27 $allowmergestagger
26ab91de7593 Uploaded
serranop
parents: 24
diff changeset
28 -fastq_ascii $ascii
26ab91de7593 Uploaded
serranop
parents: 24
diff changeset
29 -fastq_qmin $qmin
7
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
30 -fastq_qmax $qmax
25
26ab91de7593 Uploaded
serranop
parents: 24
diff changeset
31 -fastq_qmaxout $qmaxout
26
aa3acde7621c Uploaded
serranop
parents: 25
diff changeset
32 #if $output_format.format == "fastq"
aa3acde7621c Uploaded
serranop
parents: 25
diff changeset
33 -fastqout $output
aa3acde7621c Uploaded
serranop
parents: 25
diff changeset
34 #else
aa3acde7621c Uploaded
serranop
parents: 25
diff changeset
35 -fastaout $output
aa3acde7621c Uploaded
serranop
parents: 25
diff changeset
36 #end if
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
37 </command>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
38 <inputs>
17
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
39 <!-- INPUT OPTIONS -->
27
4c11ec2ae1c0 Uploaded
serranop
parents: 26
diff changeset
40 <param name="input_forward" type="data" format="fastq,fastqsanger,fastqcssanger" label="1. File with forward reads" />
4c11ec2ae1c0 Uploaded
serranop
parents: 26
diff changeset
41 <param name="input_reverse" type="data" format="fastq,fastqsanger,fastqcssanger" label="2. File with reverse reads" />
4c11ec2ae1c0 Uploaded
serranop
parents: 26
diff changeset
42 <param name="minovlen" type="integer" value="0" label="3. Minimum length of the overlap" help="'0' means no minimum." />
4c11ec2ae1c0 Uploaded
serranop
parents: 26
diff changeset
43 <param name="minmergelen" type="integer" value="0" label="4. Minimum length of the merged read" help="'0' means no minimum." />
4c11ec2ae1c0 Uploaded
serranop
parents: 26
diff changeset
44 <param name="maxmergelen" type="integer" value="0" label="5. Maximum length of the merged read" help="'0' means no maximum." />
4c11ec2ae1c0 Uploaded
serranop
parents: 26
diff changeset
45 <param name="maxdiffs" type="integer" value="0" label="6. Maximum number of mismatches allowed in the overlap region" help="'0' means any number of mismatches allowed" />
28
dcad0a24bafa Uploaded
serranop
parents: 27
diff changeset
46 <param name="truncqual" type="integer" value="0" label="7. Truncate the forward and reverse reads at the first Q&lt;=q, if present. This truncation is performed before aligning the pair. With Illumina paired reads, it is recommended to set this to 2 or higher, as low-quality tails will otherwise often cause alignment of the pair to fail" help="'0' means no quality truncation." />
dcad0a24bafa Uploaded
serranop
parents: 27
diff changeset
47 <param name="minlen" type="integer" value="0" label="8. Minimum length of the forward and reverse read, after truncating per option 7 if applicable" help="'0' means no minimum." />
27
4c11ec2ae1c0 Uploaded
serranop
parents: 26
diff changeset
48 <param name="allowmergestagger" type="boolean" truevalue="-fastq_allowmergestagger" falsevalue="" checked="false" label="9. Allow merge of a pair where the alignment is staggered" help="By default, pairs with staggered alignments are discarded." />
4c11ec2ae1c0 Uploaded
serranop
parents: 26
diff changeset
49 <param name="ascii" type="integer" value="33" label="10. ASCII_BASE constant" help="See http://drive5.com/usearch/manual/fastq_params.html" />
4c11ec2ae1c0 Uploaded
serranop
parents: 26
diff changeset
50 <param name="qmin" type="integer" value="0" label="11. Minimum Q score" />
4c11ec2ae1c0 Uploaded
serranop
parents: 26
diff changeset
51 <param name="qmax" type="integer" value="41" label="12. Maximum Q score for input files" />
4c11ec2ae1c0 Uploaded
serranop
parents: 26
diff changeset
52 <param name="qmaxout" type="integer" value="41" label="13. Maximum Q score for output files" />
17
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
53
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
54 <!-- OUTPUT OPTIONS -->
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
55 <conditional name="output_format">
19
1cfbb1c63538 Set default value for output format
serranop
parents: 18
diff changeset
56 <param name="format" type="select" label="Output format">
1cfbb1c63538 Set default value for output format
serranop
parents: 18
diff changeset
57 <option value="fastq" selected="true">FASTQ</option>
17
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
58 <option value="fasta">FASTA</option>
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
59 </param>
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
60 <when value="fastq"></when>
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
61 <when value="fasta"></when>
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
62 </conditional>
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
63 </inputs>
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
64 <outputs>
28
dcad0a24bafa Uploaded
serranop
parents: 27
diff changeset
65 <data format="fastq" name="output" label="Merge output">
dcad0a24bafa Uploaded
serranop
parents: 27
diff changeset
66 <change_format>
dcad0a24bafa Uploaded
serranop
parents: 27
diff changeset
67 <when input="format" value="fasta" format="fasta" />
dcad0a24bafa Uploaded
serranop
parents: 27
diff changeset
68 </change_format>
dcad0a24bafa Uploaded
serranop
parents: 27
diff changeset
69 </data>
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
70 </outputs>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
71 <tests>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
72 <test>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
73 <param name="input_forward" value="fastq_mergepairs_input1.fq" ftype="fastqsanger" />
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
74 <param name="input_reverse" value="fastq_mergepairs_input2.fq" ftype="fastqsanger" />
5
68305120fd75 Updated the XML and removed the executable
serranop
parents: 4
diff changeset
75 <param name="qmax" value="65" />
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
76 <output name="output" file="fastq_mergepairs_output.fq" />
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
77 </test>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
78 </tests>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
79 <help>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
80 **What it Does**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
81
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
82 Performs merging of paired reads.
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
83
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
84 The FASTQ filename for the forward reads is specified by the -fastq_mergepairs option, and the reverse read filename is specified by the -reverse option. Output files are specified by -fastqout (for FASTQ) and / or -fastaout (for FASTA).
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
85
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
86 Forward and reverse must be in 1:1 correspondence and must appear in the same order in both files. The labels for the forward and reverse read in a given pair must be identical except for a single position where a '1' appears in the forward read label and a '2' appears in the reverse read label.
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
87
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
88 -----
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
89
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
90 **Input formats**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
91
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
92 Forward read::
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
93
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
94 @IRIS:7:1:29:952#0/1
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
95 TGAGAAGCAAGAAGAAGGTTGGTTAGTGTTTTGGAG
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
96 +IRIS:7:1:29:952#0/1
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
97 aaabaaaaaaaaaaa`aaY`aa^aaa^a_a_`aa``
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
98
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
99 Reverse read::
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
100
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
101 @IRIS:7:1:29:952#0/2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
102 GACTCCAAAACACTAACCAACCTTCTTCTTGCTTCT
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
103 +IRIS:7:1:29:952#0/2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
104 aaaabaaaabaaaabbaaaa````__`__^__``__
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
105
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
106 -----
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
107
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
108 **Output**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
109
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
110 A multiple-fastq file, for example::
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
111
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
112 @IRIS:7:1:29:952#0/1
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
113 TGAGAAGCAAGAAGAAGGTTGGTTAGTGTTTTGGAGTC
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
114 +
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
115 aaJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJaa
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
116
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
117 ------
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
118
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
119 **Manual**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
120
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
121 http://drive5.com/usearch/manual/fastq_mergepairs.html
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
122
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
123 **Citation**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
124
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
125 Please cite one of these papers if you use USEARCH in published work.
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
126
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
127 Edgar,RC (2010) Search and clustering orders of magnitude faster than BLAST, Bioinformatics 26(19), 2460-2461.
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
128 doi: 10.1093/bioinformatics/btq461
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
129 </help>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
130 </tool>