annotate usearch_fastq_mergepairs.xml @ 10:af823fe7772b draft

Updated option
author serranop
date Fri, 13 Sep 2013 15:24:28 -0400
parents 5b3a8f988b81
children 3a85f43cfa4b
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>
4
4e8832829f07 Updated the command
serranop
parents: 2
diff changeset
4 <command>usearch
7
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
5 -fastq_mergepairs '$input_forward'
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
6 -reverse '$input_reverse'
9
5b3a8f988b81 Updated -fastq_minovlen option again
serranop
parents: 8
diff changeset
7 #if $minovlen.minovlen_val == '-1':
10
af823fe7772b Updated option
serranop
parents: 9
diff changeset
8 -fastq_minovlen 0
9
5b3a8f988b81 Updated -fastq_minovlen option again
serranop
parents: 8
diff changeset
9 #else
7
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
10 -fastq_minovlen $minovlen
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
11 #end if
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
12 -fastq_qmax $qmax
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
13 -fastqout '$output'
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
14 </command>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
15 <inputs>
7
94cda55f1bbb Added -fastq_minovlen option
serranop
parents: 6
diff changeset
16 <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
17 <param name="input_reverse" type="data" format="fastq,fastqsanger,fastqcssanger" label="File with reverse reads" />
8
2ef1c29e783d Updated the XML
serranop
parents: 7
diff changeset
18 <conditional name="minovlen">
2ef1c29e783d Updated the XML
serranop
parents: 7
diff changeset
19 <param name="minovlen_val" type="integer" value="-1" label="Minimum length of the overlap" help="'-1' means no minimum." />
10
af823fe7772b Updated option
serranop
parents: 9
diff changeset
20 <when value="-1"></when>
8
2ef1c29e783d Updated the XML
serranop
parents: 7
diff changeset
21 </conditional>
10
af823fe7772b Updated option
serranop
parents: 9
diff changeset
22 <param name="qmax" type="integer" value="41" label="Maximum Q score for input files" />
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
23 </inputs>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
24 <outputs>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
25 <data name='output' format='fastq' label="Merge result" />
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
26 </outputs>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
27 <tests>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
28 <test>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
29 <param name="input_forward" value="fastq_mergepairs_input1.fq" ftype="fastqsanger" />
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
30 <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
31 <param name="qmax" value="65" />
2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
32 <output name="output" file="fastq_mergepairs_output.fq" />
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
33 </test>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
34 </tests>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
35 <help>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
36 **What it Does**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
37
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
38 Performs merging of paired reads.
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
39
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
40 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
41
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
42 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
43
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
44 -----
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
45
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
46 **Input formats**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
47
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
48 Forward read::
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
49
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
50 @IRIS:7:1:29:952#0/1
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
51 TGAGAAGCAAGAAGAAGGTTGGTTAGTGTTTTGGAG
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
52 +IRIS:7:1:29:952#0/1
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
53 aaabaaaaaaaaaaa`aaY`aa^aaa^a_a_`aa``
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
54
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
55 Reverse read::
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
56
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
57 @IRIS:7:1:29:952#0/2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
58 GACTCCAAAACACTAACCAACCTTCTTCTTGCTTCT
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
59 +IRIS:7:1:29:952#0/2
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
60 aaaabaaaabaaaabbaaaa````__`__^__``__
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
61
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
62 -----
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
63
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
64 **Output**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
65
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
66 A multiple-fastq file, for example::
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
67
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
68 @IRIS:7:1:29:952#0/1
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
69 TGAGAAGCAAGAAGAAGGTTGGTTAGTGTTTTGGAGTC
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
70 +
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
71 aaJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJaa
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
72
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
73 ------
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
74
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
75 **Author**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
76
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
77 Robert C. Edgar (robert@drive5.com)
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
78
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
79 **Manual**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
80
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
81 http://drive5.com/usearch/manual/fastq_mergepairs.html
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
82
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
83 **Citation**
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
84
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
85 Please cite one of these papers if you use USEARCH in published work.
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
86
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
87 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
88 doi: 10.1093/bioinformatics/btq461
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
89 </help>
fff15877fea7 Uploaded tool XML and test data
serranop
parents:
diff changeset
90 </tool>