annotate qiime2/qiime_cutadapt_demux-paired.xml @ 4:914fa4daf16a draft

Fixes
author florianbegusch
date Wed, 31 Jul 2019 03:06:00 -0400
parents 51025741f326
children f190567fe3f6
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" ?>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_cutadapt_demux-paired" name="qiime cutadapt demux-paired" version="2019.4">
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>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2019.4">qiime2</requirement>
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:]:
florianbegusch
parents: 2
diff changeset
16 #set $file_list = $file_list + ',' + d['additional_input'].__getattr__('file_name')
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:]:
florianbegusch
parents: 2
diff changeset
27 #set $file_list = $file_list + ',' + d['additional_input'].__getattr__('file_name')
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
florianbegusch
parents: 2
diff changeset
36
florianbegusch
parents: 2
diff changeset
37 #if '__sq__' in str($mforwardbarcodescolumn):
florianbegusch
parents: 2
diff changeset
38 #set $mforwardbarcodescolumn_temp = $mforwardbarcodescolumn.replace('__sq__', "'")
florianbegusch
parents: 2
diff changeset
39 #set $mforwardbarcodescolumn = $mforwardbarcodescolumn_temp
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
40 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41
4
florianbegusch
parents: 2
diff changeset
42 #if '__db__' in str($mforwardbarcodescolumn):
florianbegusch
parents: 2
diff changeset
43 #set $mforwardbarcodescolumn_temp = $mforwardbarcodescolumn.replace('__db__', '"')
florianbegusch
parents: 2
diff changeset
44 #set $mforwardbarcodescolumn = $mforwardbarcodescolumn_temp
florianbegusch
parents: 2
diff changeset
45 #end if
florianbegusch
parents: 2
diff changeset
46
florianbegusch
parents: 2
diff changeset
47 #if str($mforwardbarcodescolumn):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 --m-forward-barcodes-column="$mforwardbarcodescolumn"
4
florianbegusch
parents: 2
diff changeset
49 #end if
florianbegusch
parents: 2
diff changeset
50
florianbegusch
parents: 2
diff changeset
51
florianbegusch
parents: 2
diff changeset
52
florianbegusch
parents: 2
diff changeset
53
florianbegusch
parents: 2
diff changeset
54 #if '__sq__' in str($mreversebarcodescolumn):
florianbegusch
parents: 2
diff changeset
55 #set $mreversebarcodescolumn_temp = $mreversebarcodescolumn.replace('__sq__', "'")
florianbegusch
parents: 2
diff changeset
56 #set $mreversebarcodescolumn = $mreversebarcodescolumn_temp
florianbegusch
parents: 2
diff changeset
57 #end if
florianbegusch
parents: 2
diff changeset
58
florianbegusch
parents: 2
diff changeset
59 #if '__db__' in str($mreversebarcodescolumn):
florianbegusch
parents: 2
diff changeset
60 #set $mreversebarcodescolumn_temp = $mreversebarcodescolumn.replace('__db__', '"')
florianbegusch
parents: 2
diff changeset
61 #set $mreversebarcodescolumn = $mreversebarcodescolumn_temp
florianbegusch
parents: 2
diff changeset
62 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 #if str($mreversebarcodescolumn):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 --m-reverse-barcodes-column="$mreversebarcodescolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67
4
florianbegusch
parents: 2
diff changeset
68
florianbegusch
parents: 2
diff changeset
69
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 #if $perrorrate:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 --p-error-rate=$perrorrate
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74
4
florianbegusch
parents: 2
diff changeset
75
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 --o-per-sample-sequences=opersamplesequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 --o-untrimmed-sequences=ountrimmedsequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 cp opersamplesequences.qza $opersamplesequences;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 cp ountrimmedsequences.qza $ountrimmedsequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <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
85 <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
86 <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
87
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 <repeat name="input_files_mforwardbarcodesfile" optional="False" title="--m-forward-barcodes-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 <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
90 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 <repeat name="input_files_mreversebarcodesfile" optional="False" title="--m-reverse-barcodes-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 <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
94 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 <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
97 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 <data format="qza" label="${tool.name} on ${on_string}: persamplesequences.qza" name="opersamplesequences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 <data format="qza" label="${tool.name} on ${on_string}: untrimmedsequences.qza" name="ountrimmedsequences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 Demultiplex paired-end sequence data with barcodes in-sequence.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 ###############################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 Demultiplex sequence data (i.e., map barcode reads to sample ids). Barcodes
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 are expected to be located within the sequence data (versus the header, or
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 a separate barcode file).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 seqs : MultiplexedPairedEndBarcodeInSequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 The paired-end sequences to be demultiplexed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 forward_barcodes : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 The sample metadata column listing the per-sample barcodes for the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 forward reads.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 reverse_barcodes : MetadataColumn[Categorical], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 The sample metadata column listing the per-sample barcodes for the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 reverse reads.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 error_rate : Float % Range(0, 1, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 The level of error tolerance, specified as the maximum allowable error
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 rate.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 per_sample_sequences : SampleData[PairedEndSequencesWithQuality]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 The resulting demultiplexed sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 untrimmed_sequences : MultiplexedPairedEndBarcodeInSequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 The sequences that were unmatched to barcodes.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 </tool>