annotate qiime2/qiime_vsearch_join-pairs.xml @ 14:a0a8d77a991c draft

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