annotate qiime2/qiime_cutadapt_demux-single.xml @ 5:a025a4a89e07 draft

Uploaded
author florianbegusch
date Mon, 05 Aug 2019 01:29:30 -0400
parents 914fa4daf16a
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-single" name="qiime cutadapt demux-single" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Demultiplex single-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-single
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-seqs=$iseqs
4
florianbegusch
parents: 2
diff changeset
11
florianbegusch
parents: 2
diff changeset
12
florianbegusch
parents: 2
diff changeset
13
florianbegusch
parents: 2
diff changeset
14 #if '__sq__' in str($mbarcodescolumn):
florianbegusch
parents: 2
diff changeset
15 #set $mbarcodescolumn_temp = $mbarcodescolumn.replace('__sq__', "'")
florianbegusch
parents: 2
diff changeset
16 #set $mbarcodescolumn = $mbarcodescolumn_temp
florianbegusch
parents: 2
diff changeset
17 #end if
florianbegusch
parents: 2
diff changeset
18
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 --m-barcodes-column="$mbarcodescolumn"
4
florianbegusch
parents: 2
diff changeset
20
florianbegusch
parents: 2
diff changeset
21
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 --o-per-sample-sequences=opersamplesequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 --o-untrimmed-sequences=ountrimmedsequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
25
4
florianbegusch
parents: 2
diff changeset
26
florianbegusch
parents: 2
diff changeset
27
florianbegusch
parents: 2
diff changeset
28
florianbegusch
parents: 2
diff changeset
29
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
30 #if $input_files_mbarcodesfile:
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 #def list_dict_to_string(list_dict):
4
florianbegusch
parents: 2
diff changeset
32 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
florianbegusch
parents: 2
diff changeset
33 #for d in list_dict[1:]:
florianbegusch
parents: 2
diff changeset
34 #set $file_list = $file_list + ',' + d['additional_input'].__getattr__('file_name')
florianbegusch
parents: 2
diff changeset
35 #end for
florianbegusch
parents: 2
diff changeset
36 #return $file_list
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 #end def
4
florianbegusch
parents: 2
diff changeset
38 --m-barcodes-file=$list_dict_to_string($input_files_mbarcodesfile)
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
39 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40
4
florianbegusch
parents: 2
diff changeset
41
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 #if $perrorrate:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 --p-error-rate=$perrorrate
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 cp opersamplesequences.qza $opersamplesequences;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 cp ountrimmedsequences.qza $ountrimmedsequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <param format="qza,no_unzip.zip" label="--i-seqs: ARTIFACT MultiplexedSingleEndBarcodeInSequence The single-end sequences to be demultiplexed. [required]" name="iseqs" optional="False" type="data"/>
4
florianbegusch
parents: 2
diff changeset
53 <repeat name="input_files_mbarcodesfile" optional="False" title="--m-barcodes-file">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <param label="--m-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
55 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <param label="--m-barcodes-column: COLUMN MetadataColumn[Categorical] The sample metadata column listing the per-sample barcodes. [required]" name="mbarcodescolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <param label="--p-error-rate: PROPORTION Range(0, 1, inclusive_end=True) The level of error tolerance, specified as the maximum allowable error rate. The default value specified by cutadapt is 0.1 (=10%), which is greater than `demux emp-*`, which is 0.0 (=0%). [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
58 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <data format="qza" label="${tool.name} on ${on_string}: persamplesequences.qza" name="opersamplesequences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <data format="qza" label="${tool.name} on ${on_string}: untrimmedsequences.qza" name="ountrimmedsequences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 Demultiplex single-end sequence data with barcodes in-sequence.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 ###############################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 Demultiplex sequence data (i.e., map barcode reads to sample ids). Barcodes
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 are expected to be located within the sequence data (versus the header, or
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 a separate barcode file).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 seqs : MultiplexedSingleEndBarcodeInSequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 The single-end sequences to be demultiplexed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 barcodes : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 The sample metadata column listing the per-sample barcodes.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 error_rate : Float % Range(0, 1, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 The level of error tolerance, specified as the maximum allowable error
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 rate. The default value specified by cutadapt is 0.1 (=10%), which is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 greater than `demux emp-*`, which is 0.0 (=0%).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 per_sample_sequences : SampleData[SequencesWithQuality]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 The resulting demultiplexed sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 untrimmed_sequences : MultiplexedSingleEndBarcodeInSequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 The sequences that were unmatched to barcodes.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 </tool>