annotate usearch_fastq_mergepairs.xml @ 36:eca87767a73c draft default tip

Uploaded
author serranop
date Sat, 14 Sep 2013 13:54:52 -0400
parents 311ab474a270
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
32
790c5a9be6fc Uploaded
serranop
parents: 31
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
7
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
6 -fastq_mergepairs '$input_forward'
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
7 -reverse '$input_reverse'
17
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
8 #if $minovlen.value != 0
13
serranop
parents: 12
diff changeset
9 -fastq_minovlen $minovlen
7
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
10 #end if
22
8aae82cf927b More testing
serranop
parents: 21
diff changeset
11 #if $minmergelen.value != 0
8aae82cf927b More testing
serranop
parents: 21
diff changeset
12 -fastq_minmergelen $minmergelen
8aae82cf927b More testing
serranop
parents: 21
diff changeset
13 #end if
24
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
14 #if $maxmergelen.value != 0
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
15 -fastq_maxmergelen $maxmergelen
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
16 #end if
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
17 #if $maxdiffs.value != 0
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
18 -fastq_maxdiffs $maxdiffs
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
19 #end if
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
20 #if $truncqual.value != 0
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
21 -fastq_truncqual $truncqual
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
22 #end if
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
23 #if $minlen.value != 0
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
24 -fastq_minlen $minlen
bce3d7a3715d Uploaded
serranop
parents: 23
diff changeset
25 #end if
25
26ab91de7593 Uploaded
serranop
parents: 24
diff changeset
26 $allowmergestagger
26ab91de7593 Uploaded
serranop
parents: 24
diff changeset
27 -fastq_ascii $ascii
26ab91de7593 Uploaded
serranop
parents: 24
diff changeset
28 -fastq_qmin $qmin
7
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
29 -fastq_qmax $qmax
25
26ab91de7593 Uploaded
serranop
parents: 24
diff changeset
30 -fastq_qmaxout $qmaxout
34
b26aa9ab77db Uploaded
serranop
parents: 33
diff changeset
31 #if $out_format.value == "fastq"
26
aa3acde7621c Uploaded
serranop
parents: 25
diff changeset
32 -fastqout $output
aa3acde7621c Uploaded
serranop
parents: 25
diff changeset
33 #else
aa3acde7621c Uploaded
serranop
parents: 25
diff changeset
34 -fastaout $output
aa3acde7621c Uploaded
serranop
parents: 25
diff changeset
35 #end if
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
36 </command>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
37 <inputs>
33
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
38 <param name="input_forward" type="data" format="fastq,fastqsanger,fastqcssanger" label="1. File with forward reads" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
39 <param name="input_reverse" type="data" format="fastq,fastqsanger,fastqcssanger" label="2. File with reverse reads" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
40 <param name="minovlen" type="integer" value="0" label="3. Minimum length of the overlap" help="'0' means no minimum." />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
41 <param name="minmergelen" type="integer" value="0" label="4. Minimum length of the merged read" help="'0' means no minimum." />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
42 <param name="maxmergelen" type="integer" value="0" label="5. Maximum length of the merged read" help="'0' means no maximum." />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
43 <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." />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
44 <param name="truncqual" type="integer" value="0" label="7. Truncate the forward and reverse reads at the first Q that is equal or less than this value, if present"
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
45 help="'0' means no quality truncation. 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." />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
46 <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
47 <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." />
33
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
48 <param name="ascii" type="integer" value="33" label="10. ASCII_BASE constant" help="See http://drive5.com/usearch/manual/fastq_params.html" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
49 <param name="qmin" type="integer" value="0" label="11. Minimum Q score" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
50 <param name="qmax" type="integer" value="41" label="12. Maximum Q score for input files" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
51 <param name="qmaxout" type="integer" value="41" label="13. Maximum Q score for output files" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
52 <param name="out_format" type="select" label="Output format">
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
53 <option value="fastq">FASTQ</option>
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
54 <option value="fasta">FASTA</option>
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
55 </param>
17
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
56 </inputs>
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
57 <outputs>
33
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
58 <data format="fastq" name="output" label="Merge output">
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
59 <change_format>
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
60 <when input="out_format" value="fasta" format="fasta" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
61 </change_format>
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
62 </data>
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
63 </outputs>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
64 <tests>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
65 <test>
33
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
66 <param name="input_forward" value="fastq_mergepairs_input1.fq" ftype="fastq" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
67 <param name="input_reverse" value="fastq_mergepairs_input2.fq" ftype="fastq" />
5
68305120fd75 Updated the XML and removed the executable
serranop
parents: 4
diff changeset
68 <param name="qmax" value="65" />
33
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
69 <output name="output" file="fastq_mergepairs_output1.fastq" />
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
70 </test>
33
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
71 <test>
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
72 <param name="input_forward" value="fastq_mergepairs_input1.fq" ftype="fastq" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
73 <param name="input_reverse" value="fastq_mergepairs_input2.fq" ftype="fastq" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
74 <param name="minovlen" value="30" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
75 <param name="qmax" value="65" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
76 <param name="out_format" value="fasta" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
77 <output name="output" file="fastq_mergepairs_output2.fasta" />
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
78 </test>
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
79 </tests>
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
80 <help>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
81 **What it Does**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
82
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
83 Performs merging of paired reads.
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
84
31
38e5953ca25f Uploaded
serranop
parents: 30
diff changeset
85 Forward and reverse must be in 1:1 correspondence and must appear in the same
38e5953ca25f Uploaded
serranop
parents: 30
diff changeset
86 order in both files. The labels for the forward and reverse read in a given
38e5953ca25f Uploaded
serranop
parents: 30
diff changeset
87 pair must be identical except for a single position where a '1' appears in the
38e5953ca25f Uploaded
serranop
parents: 30
diff changeset
88 forward read label and a '2' appears in the reverse read label.
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
89
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
90 -----
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
91
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
92 **Input formats**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
93
33
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
94 Forward reads::
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
95
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 TGAGAAGCAAGAAGAAGGTTGGTTAGTGTTTTGGAG
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
98 +IRIS:7:1:29:952#0/1
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
99 aaabaaaaaaaaaaa`aaY`aa^aaa^a_a_`aa``
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
100
33
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
101 Reverse reads::
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
102
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 GACTCCAAAACACTAACCAACCTTCTTCTTGCTTCT
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
105 +IRIS:7:1:29:952#0/2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
106 aaaabaaaabaaaabbaaaa````__`__^__``__
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
107
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
108 -----
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
109
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
110 **Output**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
111
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
112 A multiple-fastq file, for example::
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
113
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
114 @IRIS:7:1:29:952#0/1
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
115 TGAGAAGCAAGAAGAAGGTTGGTTAGTGTTTTGGAGTC
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
116 +
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
117 aaJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJaa
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
118
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
119 ------
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
120
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
121 **Manual**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
122
33
bb844274de30 Uploaded
serranop
parents: 32
diff changeset
123 * USEARCH fastq_mergepairs options: http://drive5.com/usearch/manual/fastq_mergepairs.html
30
7794d10e6e29 Uploaded
serranop
parents: 29
diff changeset
124 * FASTQ format options: http://drive5.com/usearch/manual/fastq_params.html
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
125
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
126 **Citation**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
127
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
128 Please cite one of these papers if you use USEARCH in published work.
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
129
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
130 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
131 doi: 10.1093/bioinformatics/btq461
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
132 </help>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
133 </tool>