annotate qiime2/qiime_vsearch_join-pairs.xml @ 10:21c7954105a9 draft

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