annotate qiime2/qiime_demux_emp-single.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_demux_emp-single" name="qiime demux emp-single" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Demultiplex sequence data generated with the EMP protocol.</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 demux emp-single
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-seqs=$iseqs
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --m-barcodes-column="$mbarcodescolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
14 #if $input_files_mbarcodesfile:
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #for d in list_dict[1:]:
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
18 #set $file_list = $file_list + ' --m-barcodes-file=' + d['additional_input'].__getattr__('file_name')
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 --m-barcodes-file=$list_dict_to_string($input_files_mbarcodesfile)
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
23 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #if $pnogolayerrorcorrection:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 --p-no-golay-error-correction
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #if $prevcompbarcodes:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 --p-rev-comp-barcodes
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #if $prevcompmappingbarcodes:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --p-rev-comp-mapping-barcodes
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 --o-per-sample-sequences=opersamplesequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 --o-error-correction-details=oerrorcorrectiondetails
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 cp opersamplesequences.qza $opersamplesequences;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 cp oerrorcorrectiondetails.qza $oerrorcorrectiondetails
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <inputs>
4
florianbegusch
parents: 2
diff changeset
45 <repeat name="input_files_mbarcodesfile" optional="True" title="--m-barcodes-file [optional]">
florianbegusch
parents: 2
diff changeset
46 <param label="--m-barcodes-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [optional]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip"/>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <param label="--m-barcodes-column: COLUMN MetadataColumn[Categorical] The sample metadata column containing the per-sample barcodes. [required]" name="mbarcodescolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <param label="--p-no-golay-error-correction: Do not perform 12nt Golay error correction on the barcode reads. [default: False]" name="pnogolayerrorcorrection" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <param label="--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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <param label="--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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <data format="qza" label="${tool.name} on ${on_string}: persamplesequences.qza" name="opersamplesequences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <data format="qza" label="${tool.name} on ${on_string}: errorcorrectiondetails.qza" name="oerrorcorrectiondetails"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 Demultiplex sequence data generated with the EMP protocol.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 ##########################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 Demultiplex sequence data (i.e., map barcode reads to sample ids) for data
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 generated with the Earth Microbiome Project (EMP) amplicon sequencing
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 protocol. Details about this protocol can be found at
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 http://www.earthmicrobiome.org/protocols-and-standards/
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 seqs : RawSequences | EMPSingleEndSequences | EMPPairedEndSequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 The single-end sequences to be demultiplexed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 barcodes : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 The sample metadata column containing the per-sample barcodes.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 golay_error_correction : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 Perform 12nt Golay error correction on the barcode reads.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 rev_comp_barcodes : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 If provided, the barcode sequence reads will be reverse complemented
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 prior to demultiplexing.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 rev_comp_mapping_barcodes : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 If provided, the barcode sequences in the sample metadata will be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 reverse complemented prior to demultiplexing.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 per_sample_sequences : SampleData[SequencesWithQuality]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 The resulting demultiplexed sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 error_correction_details : ErrorCorrectionDetails
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 Detail about the barcode error corrections.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 </tool>