annotate qiime2/qiime_cutadapt_demux-paired.xml @ 29:3ba9833030c1 draft

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