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