annotate qiime_deblur_denoise-16S.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_deblur_denoise-16S" name="qiime deblur denoise-16S" version="2018.4">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
3 <description>- Deblur sequences using a 16S positive filter.</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 qiime deblur denoise-16S --p-trim-length="$ptrimlength" --i-demultiplexed-seqs=$idemultiplexedseqs --o-representative-sequences=orepresentativesequences
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
9
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
10 #if $pmeanerror:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
11 --p-mean-error=$pmeanerror
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
12 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
13
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
14 #if str($cmdconfig) != 'None':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
15 --cmd-config=$cmdconfig
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
16 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
17
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
18 #if $pminreads:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
19 --p-min-reads=$pminreads
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
20 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
21
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
22 #if $pindelprob:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
23 --p-indel-prob=$pindelprob
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
25
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
26 #set $pjobstostart = '${GALAXY_SLOTS:-4}'
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
27
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
28 #if str($pjobstostart):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
29 --p-jobs-to-start="$pjobstostart"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
31
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
32 --o-stats=ostats
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
33
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
34 #if $pindelmax:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
35 --p-indel-max=$pindelmax
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
37
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
38 #if $pminsize:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
39 --p-min-size=$pminsize
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
40 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
41
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
42 #if $phashedfeatureids:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
43 --p-hashed-feature-ids
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
44 #else
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
45 --p-no-hashed-feature-ids
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
46 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
47
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
48 --o-table=otable
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
49
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
50 --p-sample-stats
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
51
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
52 ;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
53 cp orepresentativesequences.qza $orepresentativesequences;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
54 cp ostats.qza $ostats;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
55 cp otable.qza $otable;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
56 ]]></command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
57 <inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
58 <param format="qza,no_unzip.zip" label="--i-demultiplexed-seqs: SampleData[JoinedSequencesWithQuality | PairedEndSequencesWithQuality | SequencesWithQuality] The demultiplexed sequences to be denoised. [required]" name="idemultiplexedseqs" optional="False" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
59 <param label="--p-trim-length: Sequence trim length, specify -1 to disable trimming. [required]" name="ptrimlength" optional="False" type="text"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
60 <param label="--p-mean-error: The mean per nucleotide error, used for original sequence estimate. [default: 0.005]" name="pmeanerror" optional="True" type="float" value="0.005"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
61 <param label="--p-indel-prob: Insertion/deletion (indel) probability (same for N indels). [default: 0.01]" name="pindelprob" optional="True" type="float" value="0.01"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
62 <param label="--p-indel-max: Maximum number of insertion/deletions. [default: 3]" name="pindelmax" optional="True" type="integer" value="3"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
63 <param label="--p-min-reads: Retain only features appearing at least min_reads times across all samples in the resulting feature table. [default: 10]" name="pminreads" optional="True" type="integer" value="10"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
64 <param label="--p-min-size: In each sample, discard all features with an abundance less than min_size. [default: 2]" name="pminsize" optional="True" type="integer" value="2"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
65 <param label="--p-hashed-feature-ids: --p-no-hashed-feature-ids If true, hash the feature IDs. [default: True]" name="phashedfeatureids" checked="True" type="boolean"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
66 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
67 </inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
68 <outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
69 <data format="qza" label="${tool.name} on ${on_string}: representative-sequences.qza" name="orepresentativesequences"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
70 <data format="qza" label="${tool.name} on ${on_string}: stats.qza" name="ostats"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
71 <data format="qza" label="${tool.name} on ${on_string}: table.qza" name="otable"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
72 </outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
73 <help><![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
74 Deblur sequences using a 16S positive filter.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
75 ----------------------------------------------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
76
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
77 Perform sequence quality control for Illumina data using the Deblur
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
78 workflow with a 16S reference as a positive filter. Only forward reads are
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
79 supported at this time. The specific reference used is the 88% OTUs from
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
80 Greengenes 13_8. This mode of operation should only be used when data were
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
81 generated from a 16S amplicon protocol on an Illumina platform. The
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
82 reference is only used to assess whether each sequence is likely to be 16S
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
83 by a local alignment using SortMeRNA with a permissive e-value; the
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
84 reference is not used to characterize the sequences.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
85
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
86 Parameters
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
87 ----------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
88 demultiplexed_seqs : SampleData[JoinedSequencesWithQuality | PairedEndSequencesWithQuality | SequencesWithQuality]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
89 The demultiplexed sequences to be denoised.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
90 trim_length : Int
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
91 Sequence trim length, specify -1 to disable trimming.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
92 sample_stats : Bool, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
93 If true, gather stats per sample.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
94 mean_error : Float, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
95 The mean per nucleotide error, used for original sequence estimate.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
96 indel_prob : Float, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
97 Insertion/deletion (indel) probability (same for N indels).
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
98 indel_max : Int, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
99 Maximum number of insertion/deletions.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
100 min_reads : Int, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
101 Retain only features appearing at least min_reads times across all
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
102 samples in the resulting feature table.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
103 min_size : Int, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
104 In each sample, discard all features with an abundance less than
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
105 min_size.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
106 jobs_to_start : Int, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
107 Number of jobs to start (if to run in parallel).
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
108 hashed_feature_ids : Bool, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
109 If true, hash the feature IDs.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
110
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
111 Returns
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
112 -------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
113 table : FeatureTable[Frequency]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
114 The resulting denoised feature table.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
115 representative_sequences : FeatureData[Sequence]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
116 The resulting feature sequences.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
117 stats : DeblurStats
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
118 Per-sample stats if requested.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
119 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
120 </help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
121 </tool>