annotate qiime2/qiime_cutadapt_demux-paired.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: 4
diff changeset
2 <tool id="qiime_cutadapt_demux-paired" name="qiime cutadapt demux-paired" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Demultiplex paired-end sequence data with barcodes in- sequence.</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
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 cutadapt demux-paired
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9 --i-seqs=$iseqs
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
11
4
florianbegusch
parents: 2
diff changeset
12 #if $input_files_mforwardbarcodesfile:
florianbegusch
parents: 2
diff changeset
13 #def list_dict_to_string_forward(list_dict):
florianbegusch
parents: 2
diff changeset
14 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
florianbegusch
parents: 2
diff changeset
15 #for d in list_dict[1:]:
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
16 #set $file_list = $file_list + ' --m-forward-barcodes-file=' + d['additional_input'].__getattr__('file_name')
4
florianbegusch
parents: 2
diff changeset
17 #end for
florianbegusch
parents: 2
diff changeset
18 #return $file_list
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #end def
4
florianbegusch
parents: 2
diff changeset
20 --m-forward-barcodes-file=$list_dict_to_string_forward($input_files_mforwardbarcodesfile)
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
21 #end if
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
22
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
23 #if $input_files_mreversebarcodesfile:
4
florianbegusch
parents: 2
diff changeset
24 #def list_dict_to_string_reverse(list_dict):
florianbegusch
parents: 2
diff changeset
25 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
florianbegusch
parents: 2
diff changeset
26 #for d in list_dict[1:]:
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
27 #set $file_list = $file_list + ' --m-reverse-barcodes-file=' + d['additional_input'].__getattr__('file_name')
4
florianbegusch
parents: 2
diff changeset
28 #end for
florianbegusch
parents: 2
diff changeset
29 #return $file_list
florianbegusch
parents: 2
diff changeset
30 #end def
florianbegusch
parents: 2
diff changeset
31 --m-reverse-barcodes-file=$list_dict_to_string_reverse($input_files_mreversebarcodesfile)
florianbegusch
parents: 2
diff changeset
32 #end if
florianbegusch
parents: 2
diff changeset
33
florianbegusch
parents: 2
diff changeset
34
florianbegusch
parents: 2
diff changeset
35
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
36 #if str($pbatchsize):
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
37 --p-batch-size $pbatchsize
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
38 #end if
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
39
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
40 #if str($pminimumlength):
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
41 --p-minimum-length $pminimumlength
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
42 #end if
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
43
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
44
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
45
4
florianbegusch
parents: 2
diff changeset
46
florianbegusch
parents: 2
diff changeset
47 #if '__sq__' in str($mforwardbarcodescolumn):
florianbegusch
parents: 2
diff changeset
48 #set $mforwardbarcodescolumn_temp = $mforwardbarcodescolumn.replace('__sq__', "'")
florianbegusch
parents: 2
diff changeset
49 #set $mforwardbarcodescolumn = $mforwardbarcodescolumn_temp
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
50 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51
4
florianbegusch
parents: 2
diff changeset
52 #if '__db__' in str($mforwardbarcodescolumn):
florianbegusch
parents: 2
diff changeset
53 #set $mforwardbarcodescolumn_temp = $mforwardbarcodescolumn.replace('__db__', '"')
florianbegusch
parents: 2
diff changeset
54 #set $mforwardbarcodescolumn = $mforwardbarcodescolumn_temp
florianbegusch
parents: 2
diff changeset
55 #end if
florianbegusch
parents: 2
diff changeset
56
florianbegusch
parents: 2
diff changeset
57
florianbegusch
parents: 2
diff changeset
58
florianbegusch
parents: 2
diff changeset
59
florianbegusch
parents: 2
diff changeset
60 #if '__sq__' in str($mreversebarcodescolumn):
florianbegusch
parents: 2
diff changeset
61 #set $mreversebarcodescolumn_temp = $mreversebarcodescolumn.replace('__sq__', "'")
florianbegusch
parents: 2
diff changeset
62 #set $mreversebarcodescolumn = $mreversebarcodescolumn_temp
florianbegusch
parents: 2
diff changeset
63 #end if
florianbegusch
parents: 2
diff changeset
64
florianbegusch
parents: 2
diff changeset
65 #if '__db__' in str($mreversebarcodescolumn):
florianbegusch
parents: 2
diff changeset
66 #set $mreversebarcodescolumn_temp = $mreversebarcodescolumn.replace('__db__', '"')
florianbegusch
parents: 2
diff changeset
67 #set $mreversebarcodescolumn = $mreversebarcodescolumn_temp
florianbegusch
parents: 2
diff changeset
68 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
70
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
71
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
72 #if str($mforwardbarcodescolumn):
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
73 --m-forward-barcodes-column="$mforwardbarcodescolumn"
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
74 #end if
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
75
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 #if str($mreversebarcodescolumn):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 --m-reverse-barcodes-column="$mreversebarcodescolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79
4
florianbegusch
parents: 2
diff changeset
80
florianbegusch
parents: 2
diff changeset
81
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
82 #if str($perrorrate):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 --p-error-rate=$perrorrate
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86
4
florianbegusch
parents: 2
diff changeset
87
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 --o-per-sample-sequences=opersamplesequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 --o-untrimmed-sequences=ountrimmedsequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 cp opersamplesequences.qza $opersamplesequences;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 cp ountrimmedsequences.qza $ountrimmedsequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 <inputs>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
96
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
97 <param label="--p-batch-size: INTEGER The number of samples cutadapt demultiplexes Range(0, None) concurrently. Demultiplexing in smaller batches will yield the same result with marginal speed loss, and may solve 'too many files' errors related to sample quantity. Set to '0' to process all samples at once. [default: 0]" name="pbatchsize" optional="True" type="integer" value="0" min="0"/>
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
98 <param label="--p-minimum-length: INTEGER Range(1, None) Discard reads shorter than specified value. Note, the cutadapt default of 0 has been overridden, because that value produces empty sequence records. [default: 1]" name="pminimumlength" optional="True" type="integer" value="1" min="1"/>
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
99
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
100
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
101
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <param format="qza,no_unzip.zip" label="--i-seqs: ARTIFACT MultiplexedPairedEndBarcodeInSequence The paired-end sequences to be demultiplexed. [required]" name="iseqs" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 <param label="--m-forward-barcodes-column: COLUMN MetadataColumn[Categorical] The sample metadata column listing the per-sample barcodes for the forward reads. [required]" name="mforwardbarcodescolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 <param label="--m-reverse-barcodes-column: COLUMN MetadataColumn[Categorical] The sample metadata column listing the per-sample barcodes for the reverse reads. [optional]" name="mreversebarcodescolumn" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 <repeat name="input_files_mforwardbarcodesfile" optional="False" title="--m-forward-barcodes-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 <param label="--m-forward-barcodes-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [required]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 <repeat name="input_files_mreversebarcodesfile" optional="False" title="--m-reverse-barcodes-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 <param label="--m-reverse-barcodes-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [required]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 <param label="--p-error-rate: PROPORTION Range(0, 1, inclusive_end=True) The level of error tolerance, specified as the maximum allowable error rate. [default: 0.1]" name="perrorrate" optional="True" type="float" min="0" max="1" exclude_max="False" value="0.1"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 <data format="qza" label="${tool.name} on ${on_string}: persamplesequences.qza" name="opersamplesequences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 <data format="qza" label="${tool.name} on ${on_string}: untrimmedsequences.qza" name="ountrimmedsequences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 Demultiplex paired-end sequence data with barcodes in-sequence.
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
122 ################################################################
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 Demultiplex sequence data (i.e., map barcode reads to sample ids). Barcodes
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 are expected to be located within the sequence data (versus the header, or
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 a separate barcode file).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 seqs : MultiplexedPairedEndBarcodeInSequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 The paired-end sequences to be demultiplexed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 forward_barcodes : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 The sample metadata column listing the per-sample barcodes for the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 forward reads.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 reverse_barcodes : MetadataColumn[Categorical], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 The sample metadata column listing the per-sample barcodes for the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
137 reverse reads.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
138 error_rate : Float % Range(0, 1, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
139 The level of error tolerance, specified as the maximum allowable error
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
140 rate.
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
141 batch_size : Int % Range(0, None), optional
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
142 The number of samples cutadapt demultiplexes concurrently.
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
143 Demultiplexing in smaller batches will yield the same result with
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
144 marginal speed loss, and may solve "too many files" errors related to
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
145 sample quantity. Set to "0" to process all samples at once.
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
146 minimum_length : Int % Range(1, None), optional
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
147 Discard reads shorter than specified value. Note, the cutadapt default
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
148 of 0 has been overridden, because that value produces empty sequence
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
149 records.
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
150
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
151 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
152 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
153 per_sample_sequences : SampleData[PairedEndSequencesWithQuality]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
154 The resulting demultiplexed sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
155 untrimmed_sequences : MultiplexedPairedEndBarcodeInSequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
156 The sequences that were unmatched to barcodes.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
157 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
158 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
159 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
160 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
161 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
162 </tool>