annotate qiime_vsearch_join-pairs.xml @ 0:09b7bcb72fa7 draft

Uploaded
author florianbegusch
date Thu, 24 May 2018 02:11:44 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_vsearch_join-pairs" name="qiime vsearch join-pairs" version="2018.4">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Join paired-end reads.</description>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2018.4">qiime2</requirement>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
7 <command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
8 <![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
9 qiime vsearch join-pairs --i-demultiplexed-seqs=$idemultiplexedseqs
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
10
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
11 #if $pminovlen:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
12 --p-minovlen=$pminovlen
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
13 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
14
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
15 #if str($ptruncqual):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
16 --p-truncqual="$ptruncqual"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
18
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
19 #if str($cmdconfig) != 'None':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
20 --cmd-config=$cmdconfig
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
22
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
23 #if str($pminmergelen):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
24 --p-minmergelen="$pminmergelen"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
26
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
27 #if $pmaxdiffs:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
28 --p-maxdiffs=$pmaxdiffs
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
29 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
30
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
31 #if str($pqminout):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
32 --p-qminout="$pqminout"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
33 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
34
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
35 #if str($pmaxmergelen):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
36 --p-maxmergelen="$pmaxmergelen"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
37 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
38
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
39 #if str($pmaxns):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
40 --p-maxns="$pmaxns"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
41 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
42
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
43 #if $pallowmergestagger:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
44 --p-allowmergestagger
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
45 #else
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
46 --p-no-allowmergestagger
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
47 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
48
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
49 #if $pminlen:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
50 --p-minlen=$pminlen
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
51 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
52
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
53 #if $pqmax:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
54 --p-qmax=$pqmax
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
55 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
56
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
57 #if str($pmaxee):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
58 --p-maxee="$pmaxee"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
59 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
60
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
61 #if str($pqmin):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
62 --p-qmin="$pqmin"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
63 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
64
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
65 #if $pqmaxout:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
66 --p-qmaxout=$pqmaxout
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
67 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
68 --o-joined-sequences=ojoinedsequences;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
69
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
70 cp ojoinedsequences.qza $ojoinedsequences;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
71 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
72 </command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
73 <inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
74 <param format="qza,no_unzip.zip" label="--i-demultiplexed-seqs: SampleData[PairedEndSequencesWithQuality] The demultiplexed paired-end sequences to be joined. [required]" name="idemultiplexedseqs" optional="False" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
75
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
76 <param label="--p-truncqual: Truncate sequences at the first base with the specified quality score value or lower. [optional]" name="ptruncqual" optional="True" type="text"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
77
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
78 <param label="--p-minlen: Sequences shorter than minlen after truncation are discarded. [default: 1]" name="pminlen" optional="True" type="integer" value="1"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
79 <param label="--p-maxns: Sequences with more than maxns N characters are discarded. [optional]" name="pmaxns" optional="True" type="text"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
80
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
81 <param label="--p-allowmergestagger: --p-no-allowmergestagger Allow joining of staggered read pairs. [default: False]" name="pallowmergestagger" checked="False" type="boolean"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
82
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
83 <param label="--p-minovlen: Minimum overlap length of forward and reverse reads for joining. [default: 10]" name="pminovlen" optional="True" type="integer" value="10"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
84 <param label="--p-maxdiffs: Maximum number of mismatches in the forward/reverse read overlap for joining. [default: 10]" name="pmaxdiffs" optional="True" type="integer" value="10"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
85
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
86 <param label="--p-minmergelen: Minimum length of the joined read to be retained. [optional]" name="pminmergelen" optional="True" type="text"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
87 <param label="--p-maxmergelen: Maximum length of the joined read to be retained. [optional]" name="pmaxmergelen" optional="True" type="text"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
88
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
89 <param label="--p-maxee: Maximum number of expected errors in the joined read to be retained. [optional]" name="pmaxee" optional="True" type="text"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
90
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
91 <param label="--p-qmin: The minimum allowed quality score in the input. [default: 0]" name="pqmin" optional="True" type="text" value="0"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
92 <param label="--p-qminout: The minimum allowed quality score to use in output. [default: 0]" name="pqminout" optional="True" type="text" value="0"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
93
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
94 <param label="--p-qmax: The maximum allowed quality score in the input. [default: 41]" name="pqmax" optional="True" type="integer" value="41"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
95 <param label="--p-qmaxout: The maximum allowed quality score to use in output. [default: 41]" name="pqmaxout" optional="True" type="integer" value="41"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
96
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
97 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
98 </inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
99 <outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
100 <data format="qza" label="${tool.name} on ${on_string}: joined-sequences.qza" name="ojoinedsequences"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
101 </outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
102 <help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
103 <![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
104 Join paired-end reads.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
105 -----------------------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
106
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
107 Join paired-end sequence reads using vsearch's merge_pairs function. The
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
108 qmin, qminout, qmax, and qmaxout parameters should only need to be modified
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
109 when working with older fastq sequence data. See the vsearch documentation
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
110 for details on how paired-end joining is performed, and for more
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
111 information on the parameters to this method.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
112
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
113 Parameters
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
114 ----------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
115 demultiplexed_seqs : SampleData[PairedEndSequencesWithQuality]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
116 The demultiplexed paired-end sequences to be joined.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
117 truncqual : Int % Range(0, None), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
118 Truncate sequences at the first base with the specified quality score
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
119 value or lower.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
120 minlen : Int % Range(0, None), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
121 Sequences shorter than minlen after truncation are discarded.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
122 maxns : Int % Range(0, None), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
123 Sequences with more than maxns N characters are discarded.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
124 allowmergestagger : Bool, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
125 Allow joining of staggered read pairs.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
126 minovlen : Int % Range(0, None), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
127 Minimum overlap length of forward and reverse reads for joining.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
128 maxdiffs : Int % Range(0, None), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
129 Maximum number of mismatches in the forward/reverse read overlap for
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
130 joining.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
131 minmergelen : Int % Range(0, None), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
132 Minimum length of the joined read to be retained.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
133 maxmergelen : Int % Range(0, None), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
134 Maximum length of the joined read to be retained.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
135 maxee : Float % Range(0.0, None), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
136 Maximum number of expected errors in the joined read to be retained.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
137 qmin : Int % Range(-5, 2, inclusive_end=True), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
138 The minimum allowed quality score in the input.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
139 qminout : Int % Range(-5, 2, inclusive_end=True), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
140 The minimum allowed quality score to use in output.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
141 qmax : Int % Range(40, 41, inclusive_end=True), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
142 The maximum allowed quality score in the input.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
143 qmaxout : Int % Range(40, 41, inclusive_end=True), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
144 The maximum allowed quality score to use in output.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
145
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
146 Returns
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
147 -------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
148 joined_sequences : SampleData[JoinedSequencesWithQuality]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
149 The joined sequences.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
150 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
151 </help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
152 </tool>