annotate qiime_cutadapt_demux-single.xml @ 1:f2028d8efed6 draft default tip

Add tool_data_table_conf.xml.sample
author florianbegusch
date Thu, 24 May 2018 03:40:50 -0400
parents 09b7bcb72fa7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_cutadapt_demux-single" name="qiime cutadapt demux-single" version="2018.4">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Demultiplex single-end sequence data with barcodes in- sequence.</description>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2018.4">qiime2</requirement>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
8
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
9 qiime cutadapt demux-single
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
10
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
11 #def list_dict_to_string(list_dict):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
12 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
13 #for d in list_dict[1:]:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
14 #set $file_list = $file_list + ',' + d['additional_input'].__getattr__('file_name')
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
15 #end for
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
16 #return $file_list
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
17 #end def
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
18
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
19 --m-barcodes-file=$list_dict_to_string($input_files_mbarcodesfile) --i-seqs=$iseqs --m-barcodes-column="$mbarcodescolumn"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
20
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
21 #if str($cmdconfig) != 'None':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
22 --cmd-config=$cmdconfig
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
24
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
25 --o-per-sample-sequences=opersamplesequences --o-untrimmed-sequences=ountrimmedsequences
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
26
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
27 #if $perrorrate:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
28 --p-error-rate=$perrorrate
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
29 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
30 ;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
31 cp opersamplesequences.qza $opersamplesequences;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
32 cp ountrimmedsequences.qza $ountrimmedsequences;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
33 ]]></command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
34 <inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
35 <param format="qza,no_unzip.zip" label="--i-seqs: MultiplexedSingleEndBarcodeInSequence The single-end sequences to be demultiplexed. [required]" name="iseqs" optional="False" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
36
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
37 <repeat name="input_files_mbarcodesfile" optional="False" title="--m-barcodes-file">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
38 <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" />
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
39 </repeat>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
40 <param label="--m-barcodes-column: MetadataColumn[Categorical] Column from metadata file or artifact viewable as metadata. The sample metadata column listing the per-sample barcodes. [required]" name="mbarcodescolumn" optional="False" type="text"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
41
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
42 <param label="--p-error-rate: 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" value="0.1"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
43
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
44 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
45 </inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
46 <outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
47 <data format="qza" label="${tool.name} on ${on_string}: per-sample-sequences.qza" name="opersamplesequences"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
48 <data format="qza" label="${tool.name} on ${on_string}: untrimmed-sequences.qza" name="ountrimmedsequences"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
49 </outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
50 <help><![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
51 Demultiplex single-end sequence data with barcodes in-sequence.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
52 ----------------------------------------------------------------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
53
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
54 Demultiplex sequence data (i.e., map barcode reads to sample ids). Barcodes
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
55 are expected to be located within the sequence data (versus the header, or
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
56 a separate barcode file).
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
57
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
58 Parameters
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
59 ----------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
60 seqs : MultiplexedSingleEndBarcodeInSequence
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
61 The single-end sequences to be demultiplexed.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
62 barcodes : MetadataColumn[Categorical]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
63 The sample metadata column listing the per-sample barcodes.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
64 error_rate : Float % Range(0, 1, inclusive_end=True), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
65 The level of error tolerance, specified as the maximum allowable error
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
66 rate. The default value specified by cutadapt is 0.1 (=10%), which is
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
67 greater than `demux emp-*`, which is 0.0 (=0%).
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
68
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
69 Returns
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
70 -------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
71 per_sample_sequences : SampleData[SequencesWithQuality]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
72 The resulting demultiplexed sequences.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
73 untrimmed_sequences : MultiplexedSingleEndBarcodeInSequence
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
74 The sequences that were unmatched to barcodes.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
75 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
76 </help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
77 </tool>