annotate qiime2-2020.8/qiime_demux_emp-single.xml @ 22:292c84bd5ab6 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 12:55:05 +0000
parents d93d8888f0b0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_demux_emp-single" name="qiime demux emp-single"
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Demultiplex sequence data generated with the EMP protocol.</description>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
9 qiime demux emp-single
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
10
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
11 --i-seqs=$iseqs
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
12 # if $input_files_mbarcodesfile:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
13 # def list_dict_to_string(list_dict):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
14 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
15 # for d in list_dict[1:]:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
16 # set $file_list = $file_list + ' --m-barcodes-file=' + d['additional_input'].__getattr__('file_name')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
17 # end for
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
18 # return $file_list
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
19 # end def
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
20 --m-barcodes-file=$list_dict_to_string($input_files_mbarcodesfile)
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
21 # end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
22
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
23 #if '__ob__' in str($mbarcodescolumn):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
24 #set $mbarcodescolumn_temp = $mbarcodescolumn.replace('__ob__', '[')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
25 #set $mbarcodescolumn = $mbarcodescolumn_temp
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
26 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
27 #if '__cb__' in str($mbarcodescolumn):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
28 #set $mbarcodescolumn_temp = $mbarcodescolumn.replace('__cb__', ']')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
29 #set $mbarcodescolumn = $mbarcodescolumn_temp
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
31 #if 'X' in str($mbarcodescolumn):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
32 #set $mbarcodescolumn_temp = $mbarcodescolumn.replace('X', '\\')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
33 #set $mbarcodescolumn = $mbarcodescolumn_temp
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
34 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
35 #if '__sq__' in str($mbarcodescolumn):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
36 #set $mbarcodescolumn_temp = $mbarcodescolumn.replace('__sq__', "'")
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
37 #set $mbarcodescolumn = $mbarcodescolumn_temp
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
38 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
39 #if '__db__' in str($mbarcodescolumn):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
40 #set $mbarcodescolumn_temp = $mbarcodescolumn.replace('__db__', '"')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
41 #set $mbarcodescolumn = $mbarcodescolumn_temp
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
42 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
43
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
44 --m-barcodes-column=$mbarcodescolumn
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
45
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
46
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
47 #if $pnogolayerrorcorrection:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
48 --p-no-golay-error-correction
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
49 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
50
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
51 #if $prevcompbarcodes:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
52 --p-rev-comp-barcodes
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
53 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
54
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
55 #if $prevcompmappingbarcodes:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
56 --p-rev-comp-mapping-barcodes
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
57 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
58
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
59 --o-per-sample-sequences=opersamplesequences
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
60
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
61 --o-error-correction-details=oerrorcorrectiondetails
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
62
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
63 #if str($examples) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
64 --examples=$examples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
65 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
66
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
67 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
68 cp oerrorcorrectiondetails.qza $oerrorcorrectiondetails
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
69
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
70 ]]></command>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
71 <inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
72 <param format="qza,no_unzip.zip" label="--i-seqs: ARTIFACT RawSequences | EMPSingleEndSequences | EMPPairedEndSequences The single-end sequences to be demultiplexed. [required]" name="iseqs" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
73 <repeat name="input_files_mbarcodesfile" optional="True" title="--m-barcodes-file">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
74 <param format="tabular,qza,no_unzip.zip" label="--m-barcodes-file: METADATA" name="additional_input" optional="True" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
75 </repeat>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
76 <param label="--m-barcodes-column: COLUMN MetadataColumn[Categorical] The sample metadata column containing the per-sample barcodes. [required]" name="mbarcodescolumn" optional="False" type="text" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
77 <param label="--p-no-golay-error-correction: Do not perform 12nt Golay error correction on the barcode reads. [default: True]" name="pnogolayerrorcorrection" selected="False" type="boolean" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
78 <param format="tabular,qza,no_unzip.zip" label="--p-rev-comp-barcodes: --p-rev-comp-barcodes: / --p-no-rev-comp-barcodes If provided, the barcode sequence reads will be reverse complemented prior to demultiplexing. [default: False]" name="prevcompbarcodes" selected="False" type="boolean" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
79 <param format="tabular,qza,no_unzip.zip" label="--p-rev-comp-mapping-barcodes: --p-rev-comp-mapping-barcodes: / --p-no-rev-comp-mapping-barcodes If provided, the barcode sequences in the sample metadata will be reverse complemented prior to demultiplexing. [default: False]" name="prevcompmappingbarcodes" selected="False" type="boolean" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
80 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
81
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
82 </inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
83
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
84 <outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
85 <data format="qza" label="${tool.name} on ${on_string}: persamplesequences.qza" name="opersamplesequences" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
86 <data format="qza" label="${tool.name} on ${on_string}: errorcorrectiondetails.qza" name="oerrorcorrectiondetails" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
87
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
88 </outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
89
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
90 <help><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
91 Demultiplex sequence data generated with the EMP protocol.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
92 ###############################################################
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
93
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
94 Demultiplex sequence data (i.e., map barcode reads to sample ids) for data
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
95 generated with the Earth Microbiome Project (EMP) amplicon sequencing
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
96 protocol. Details about this protocol can be found at
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
97 http://www.earthmicrobiome.org/protocols-and-standards/
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
98
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
99 Parameters
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
100 ----------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
101 seqs : RawSequences | EMPSingleEndSequences | EMPPairedEndSequences
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
102 The single-end sequences to be demultiplexed.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
103 barcodes : MetadataColumn[Categorical]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
104 The sample metadata column containing the per-sample barcodes.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
105 golay_error_correction : Bool, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
106 Perform 12nt Golay error correction on the barcode reads.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
107 rev_comp_barcodes : Bool, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
108 If provided, the barcode sequence reads will be reverse complemented
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
109 prior to demultiplexing.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
110 rev_comp_mapping_barcodes : Bool, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
111 If provided, the barcode sequences in the sample metadata will be
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
112 reverse complemented prior to demultiplexing.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
113
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
114 Returns
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
115 -------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
116 per_sample_sequences : SampleData[SequencesWithQuality]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
117 The resulting demultiplexed sequences.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
118 error_correction_details : ErrorCorrectionDetails
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
119 Detail about the barcode error corrections.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
120 ]]></help>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
121 <macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
122 <import>qiime_citation.xml</import>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
123 </macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
124 <expand macro="qiime_citation"/>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
125 </tool>