annotate qiime2/qiime_cutadapt_demux-paired.xml @ 2:51025741f326 draft

Uploaded
author florianbegusch
date Thu, 18 Jul 2019 12:19:15 -0400
parents 370e0b6e9826
children 914fa4daf16a
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
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #set $file_list = $file_list + ',' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
20 #if $input_files_mforwardbarcodesfile:
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 --m-forward-barcodes-file=$list_dict_to_string("$input_files_mforwardbarcodesfile")
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
22 #end if
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
23
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
24 #if $input_files_mreversebarcodesfile:
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 --m-reverse-barcodes-file=$list_dict_to_string("$input_files_mreversebarcodesfile")
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
26 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 --m-forward-barcodes-column="$mforwardbarcodescolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #if str($mreversebarcodescolumn):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 --m-reverse-barcodes-column="$mreversebarcodescolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #if $perrorrate:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --p-error-rate=$perrorrate
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 --o-per-sample-sequences=opersamplesequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 --o-untrimmed-sequences=ountrimmedsequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 cp opersamplesequences.qza $opersamplesequences;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 cp ountrimmedsequences.qza $ountrimmedsequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <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
48 <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
49 <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
50
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <repeat name="input_files_mforwardbarcodesfile" optional="False" title="--m-forward-barcodes-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <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
53 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <repeat name="input_files_mreversebarcodesfile" optional="False" title="--m-reverse-barcodes-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <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
57 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <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
60 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <data format="qza" label="${tool.name} on ${on_string}: persamplesequences.qza" name="opersamplesequences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 <data format="qza" label="${tool.name} on ${on_string}: untrimmedsequences.qza" name="ountrimmedsequences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 Demultiplex paired-end sequence data with barcodes in-sequence.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 ###############################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 Demultiplex sequence data (i.e., map barcode reads to sample ids). Barcodes
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 are expected to be located within the sequence data (versus the header, or
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 a separate barcode file).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 seqs : MultiplexedPairedEndBarcodeInSequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 The paired-end sequences to be demultiplexed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 forward_barcodes : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 The sample metadata column listing the per-sample barcodes for the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 forward reads.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 reverse_barcodes : MetadataColumn[Categorical], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 The sample metadata column listing the per-sample barcodes for the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 reverse reads.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 error_rate : Float % Range(0, 1, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 The level of error tolerance, specified as the maximum allowable error
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 rate.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 per_sample_sequences : SampleData[PairedEndSequencesWithQuality]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 The resulting demultiplexed sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 untrimmed_sequences : MultiplexedPairedEndBarcodeInSequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 The sequences that were unmatched to barcodes.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 </tool>