annotate usearch_fastq_mergepairs.xml @ 17:cb90b8246ef2 draft

New options
author serranop
date Fri, 13 Sep 2013 17:00:10 -0400
parents 3244a7ca3faa
children 861744133340
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
1 <tool id="usearch_fastq_mergepairs" name="usearch fastq_mergepairs" version="0.0.1">
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
17
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
12 #if $minmergelen.value != 0
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
13 -fastq_minmergelen $minmergelen
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
14 #end if
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
15 #if $maxmergelen.value != 0
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
16 -fastq_maxmergelen $maxmergelen
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
17 #end if
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
18 #if $maxdiffs.value != 0
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
19 -fastq_maxdiffs $maxdiffs
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
20 #end if
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
21 #if $truncqual.value != 0
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
22 -fastq_truncqual $truncqual
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
23 #end if
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
24 #if $minlen.value != 0
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
25 -fastq_minlen $minlen
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
26 #end if
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
27 $allowmergestagger
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
28 -fastq_ascii $ascii
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
29 -fastq_qmin $qmin
7
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
30 -fastq_qmax $qmax
17
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
31 -fastq_qmaxout $qmaxout
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
32 #if $output_format.format == "fastq"
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
33 -fastqout $output
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
34 #else
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
35 -fastaout $output
cb90b8246ef2 New options
serranop
parents: 16
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 -->
7
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
40 <param name="input_forward" type="data" format="fastq,fastqsanger,fastqcssanger" label="File with forward reads" />
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
41 <param name="input_reverse" type="data" format="fastq,fastqsanger,fastqcssanger" label="File with reverse reads" />
11
3a85f43cfa4b Updated option
serranop
parents: 10
diff changeset
42 <param name="minovlen" type="integer" value="0" label="Minimum length of the overlap" help="'0' means no minimum." />
17
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
43 <param name="minmergelen" type="integer" value="0" label="Minimum length of the merged read" help="'0' means no minimum." />
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
44 <param name="maxmergelen" type="integer" value="0" label="Maximum length of the merged read" help="'0' means no maximum." />
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
45 <param name="maxdiffs" type="integer" value="0" label="Maximum number of mismatches allowed in the overlap region" help="'0' means any number of mismatches allowed" />
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
46 <param name="truncqual" type="integer" value="0" label="Truncate the forward and reverse reads at the first Q<=q, if present. This truncation is performed before aligning the pair. With Illumina paired reads, it is recommended to use ‑fastq_trunqual 2 or higher, as low-quality tails will otherwise often cause alignment of the pair to fail." help="'0' means no quality truncation." />
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
47 <param name="minlen" type="integer" value="0" label="Minimum length of the forward and reverse read, after truncating per ‑fastq_truncqual if applicable." help="'0' means no minimum." />
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
48 <param name="allowmergestagger" type="boolean" truevalue="-fastq_allowmergestagger" falsevalue="" checked="false" label="Allow merge of a pair where the alignment is staggered like this: --FORWARD
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
49 REVERSE--" help="By default, pairs with staggered alignments are discarded." />
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
50 <param name="ascii" type="integer" value="33" label="ASCII_BASE constant" help="See http://drive5.com/usearch/manual/fastq_params.html" />
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
51 <param name="qmin" type="integer" value="0" label="Minimum Q score" />
10
af823fe7772b Updated option
serranop
parents: 9
diff changeset
52 <param name="qmax" type="integer" value="41" label="Maximum Q score for input files" />
17
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
53 <param name="qmaxout" type="integer" value="41" label="Maximum Q score for output files" />
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
54
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
55 <!-- OUTPUT OPTIONS -->
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
56 <conditional name="output_format">
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
57 <param name="format" type="select" display="radio" label="Output format">
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
58 <option value="fastq">FASTQ</option>
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
59 <option value="fasta">FASTA</option>
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
60 </param>
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
61 <when value="fastq"></when>
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
62 <when value="fasta"></when>
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
63 </conditional>
cb90b8246ef2 New options
serranop
parents: 16
diff changeset
64 </inputs>
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
65 <outputs>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
66 <data name='output' format='fastq' label="Merge result" />
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
67 </outputs>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
68 <tests>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
69 <test>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
70 <param name="input_forward" value="fastq_mergepairs_input1.fq" ftype="fastqsanger" />
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
71 <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
72 <param name="qmax" value="65" />
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
73 <output name="output" file="fastq_mergepairs_output.fq" />
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
74 </test>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
75 </tests>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
76 <help>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
77 **What it Does**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
78
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
79 Performs merging of paired reads.
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
80
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
81 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
82
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
83 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
84
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
85 -----
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
86
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
87 **Input formats**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
88
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
89 Forward read::
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
90
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
91 @IRIS:7:1:29:952#0/1
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
92 TGAGAAGCAAGAAGAAGGTTGGTTAGTGTTTTGGAG
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
93 +IRIS:7:1:29:952#0/1
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
94 aaabaaaaaaaaaaa`aaY`aa^aaa^a_a_`aa``
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
95
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
96 Reverse read::
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
97
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
98 @IRIS:7:1:29:952#0/2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
99 GACTCCAAAACACTAACCAACCTTCTTCTTGCTTCT
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
100 +IRIS:7:1:29:952#0/2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
101 aaaabaaaabaaaabbaaaa````__`__^__``__
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
102
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
103 -----
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
104
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
105 **Output**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
106
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
107 A multiple-fastq file, for example::
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
108
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
109 @IRIS:7:1:29:952#0/1
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
110 TGAGAAGCAAGAAGAAGGTTGGTTAGTGTTTTGGAGTC
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
111 +
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
112 aaJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJaa
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
113
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
114 ------
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
115
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
116 **Manual**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
117
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
118 http://drive5.com/usearch/manual/fastq_mergepairs.html
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
119
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
120 **Citation**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
121
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
122 Please cite one of these papers if you use USEARCH in published work.
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
123
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
124 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
125 doi: 10.1093/bioinformatics/btq461
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
126 </help>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
127 </tool>