annotate qiime2/qiime_cutadapt_demux-single.xml @ 12:33e7a3470046 draft

Deleted selected files
author florianbegusch
date Thu, 03 Sep 2020 09:44:28 +0000
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_cutadapt_demux-single" name="qiime cutadapt demux-single" version="2019.7">
0
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>
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 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
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
13 #if str($pbatchsize):
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
14 --p-batch-size $pbatchsize
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
15 #end if
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
16
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
17 #if str($pminimumlength):
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
18 --p-minimum-length $pminimumlength
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
19 #end if
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
20
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
21
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
22
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
23
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
24
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
25 #if $input_files_mbarcodesfile:
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
26 #def list_dict_to_string(list_dict):
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
27 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
28 #for d in list_dict[1:]:
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
29 #set $file_list = $file_list + ' --m-barcodes-file=' + d['additional_input'].__getattr__('file_name')
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
30 #end for
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
31 #return $file_list
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
32 #end def
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
33 --m-barcodes-file=$list_dict_to_string($input_files_mbarcodesfile)
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
34 #end if
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
35
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
36
4
florianbegusch
parents: 2
diff changeset
37
florianbegusch
parents: 2
diff changeset
38 #if '__sq__' in str($mbarcodescolumn):
florianbegusch
parents: 2
diff changeset
39 #set $mbarcodescolumn_temp = $mbarcodescolumn.replace('__sq__', "'")
florianbegusch
parents: 2
diff changeset
40 #set $mbarcodescolumn = $mbarcodescolumn_temp
florianbegusch
parents: 2
diff changeset
41 #end if
florianbegusch
parents: 2
diff changeset
42
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 --m-barcodes-column="$mbarcodescolumn"
4
florianbegusch
parents: 2
diff changeset
44
florianbegusch
parents: 2
diff changeset
45
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
47 #if str($perrorrate):
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
48 --p-error-rate=$perrorrate
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
49 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50
4
florianbegusch
parents: 2
diff changeset
51
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
52 --o-per-sample-sequences=opersamplesequences
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
53 --o-untrimmed-sequences=ountrimmedsequences
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 cp opersamplesequences.qza $opersamplesequences;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 cp ountrimmedsequences.qza $ountrimmedsequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <inputs>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
60
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
61 <param label="--p-batch-size: INTEGER The number of samples cutadapt demultiplexes Range(0, None) concurrently. Demultiplexing in smaller batches will yield the same result with marginal speed loss, and may solve 'too many files' errors related to sample quantity. Set to '0' to process all samples at once. [default: 0]" name="pbatchsize" optional="True" type="integer" value="0" min="0"/>
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
62 <param label="--p-minimum-length: INTEGER Range(1, None) Discard reads shorter than specified value. Note, the cutadapt default of 0 has been overridden, because that value produces empty sequence records. [default: 1]" name="pminimumlength" optional="True" type="integer" value="1" min="1"/>
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
63
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
64
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <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
66 <repeat name="input_files_mbarcodesfile" optional="False" title="--m-barcodes-file">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <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
68 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <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
70 <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
71 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <data format="qza" label="${tool.name} on ${on_string}: persamplesequences.qza" name="opersamplesequences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <data format="qza" label="${tool.name} on ${on_string}: untrimmedsequences.qza" name="ountrimmedsequences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 Demultiplex single-end sequence data with barcodes in-sequence.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 ###############################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 Demultiplex sequence data (i.e., map barcode reads to sample ids). Barcodes
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 are expected to be located within the sequence data (versus the header, or
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 a separate barcode file).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 seqs : MultiplexedSingleEndBarcodeInSequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 The single-end sequences to be demultiplexed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 barcodes : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 The sample metadata column listing the per-sample barcodes.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 error_rate : Float % Range(0, 1, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 The level of error tolerance, specified as the maximum allowable error
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 rate. The default value specified by cutadapt is 0.1 (=10%), which is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 greater than `demux emp-*`, which is 0.0 (=0%).
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
94 batch_size : Int % Range(0, None), optional
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
95 The number of samples cutadapt demultiplexes concurrently.
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
96 Demultiplexing in smaller batches will yield the same result with
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
97 marginal speed loss, and may solve "too many files" errors related to
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
98 sample quantity. Set to "0" to process all samples at once.
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
99 minimum_length : Int % Range(1, None), optional
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
100 Discard reads shorter than specified value. Note, the cutadapt default
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
101 of 0 has been overridden, because that value produces empty sequence
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
102 records.
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 per_sample_sequences : SampleData[SequencesWithQuality]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 The resulting demultiplexed sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 untrimmed_sequences : MultiplexedSingleEndBarcodeInSequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 The sequences that were unmatched to barcodes.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 </tool>