annotate qiime2/qiime_deblur_denoise-other.xml @ 9:f190567fe3f6 draft

Uploaded
author florianbegusch
date Wed, 14 Aug 2019 15:12:48 -0400
parents de4c22a52df4
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: 6
diff changeset
2 <tool id="qiime_deblur_denoise-other" name="qiime deblur denoise-other" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Deblur sequences using a user-specified positive filter.</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
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 deblur denoise-other
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-demultiplexed-seqs=$idemultiplexedseqs
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-reference-seqs=$ireferenceseqs
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
6
florianbegusch
parents: 0
diff changeset
13 #if str($ptrimlength):
florianbegusch
parents: 0
diff changeset
14 --p-trim-length="$ptrimlength"
florianbegusch
parents: 0
diff changeset
15 #end if
florianbegusch
parents: 0
diff changeset
16
florianbegusch
parents: 0
diff changeset
17 #if str($plefttrimlen):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 --p-left-trim-len=$plefttrimlen
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
6
florianbegusch
parents: 0
diff changeset
21 #if str($psamplestats):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 --p-sample-stats
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
6
florianbegusch
parents: 0
diff changeset
25 #if str($pmeanerror):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 --p-mean-error=$pmeanerror
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28
6
florianbegusch
parents: 0
diff changeset
29 #if str($pindelprob):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 --p-indel-prob=$pindelprob
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32
6
florianbegusch
parents: 0
diff changeset
33 #if str($pindelmax):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 --p-indel-max=$pindelmax
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36
6
florianbegusch
parents: 0
diff changeset
37 #if str($pminreads):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 --p-min-reads=$pminreads
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40
6
florianbegusch
parents: 0
diff changeset
41 #if str($pminsize):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 --p-min-size=$pminsize
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 #set $pjobstostart = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 #if str($pjobstostart):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 --p-jobs-to-start="$pjobstostart"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51
6
florianbegusch
parents: 0
diff changeset
52 #if str($pnohashedfeatureids):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 --p-no-hashed-feature-ids
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 --o-table=otable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 --o-representative-sequences=orepresentativesequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 --o-stats=ostats
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 cp otable.qza $otable;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 cp orepresentativesequences.qza $orepresentativesequences;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 cp ostats.qza $ostats
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <param format="qza,no_unzip.zip" label="--i-demultiplexed-seqs: ARTIFACT SampleData[SequencesWithQuality | PairedEndSequencesWithQuality | JoinedSequencesWithQuality] The demultiplexed sequences to be denoised. [required]" name="idemultiplexedseqs" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <param format="qza,no_unzip.zip" label="--i-reference-seqs: ARTIFACT FeatureData[Sequence] Positive filtering database. Keep all sequences aligning to these sequences. [required]" name="ireferenceseqs" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <param label="--p-trim-length: INTEGER Sequence trim length, specify -1 to disable trimming. [required]" name="ptrimlength" optional="False" value="" type="integer"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 <param label="--p-left-trim-len: INTEGER Range(0, None) Sequence trimming from the 5' end. A value of 0 will disable this trim. [default: 0]" name="plefttrimlen" optional="True" type="integer" min="0" value="0"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <param label="--p-sample-stats: --p-no-sample-stats If true, gather stats per sample. [default: False]" name="psamplestats" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <param label="--p-mean-error: NUMBER The mean per nucleotide error, used for original sequence estimate. [default: 0.005]" name="pmeanerror" optional="True" type="float" value="0.005"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <param label="--p-indel-prob: NUMBER Insertion/deletion (indel) probability (same for N indels). [default: 0.01]" name="pindelprob" optional="True" type="float" value="0.01"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 <param label="--p-indel-max: INTEGER Maximum number of insertion/deletions. [default: 3]" name="pindelmax" optional="True" type="integer" value="3"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <param label="--p-min-reads: INTEGER 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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <param label="--p-min-size: INTEGER In each sample, discard all features with an abundance less than min-size. [default: 2]" name="pminsize" optional="True" type="integer" value="2"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <param label="--p-no-hashed-feature-ids: If false, hash the feature IDs. [default: False]" name="pnohashedfeatureids" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 <data format="qza" label="${tool.name} on ${on_string}: table.qza" name="otable"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <data format="qza" label="${tool.name} on ${on_string}: representativesequences.qza" name="orepresentativesequences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <data format="qza" label="${tool.name} on ${on_string}: stats.qza" name="ostats"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 Deblur sequences using a user-specified positive filter.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 ########################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 Perform sequence quality control for Illumina data using the Deblur
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 workflow, including positive alignment-based filtering. Only forward reads
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 are supported at this time. This mode of execution is particularly useful
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 when operating on non-16S data. For example, to apply Deblur to 18S data,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 you would want to specify a reference composed of 18S sequences in order to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 filter out sequences which do not appear to be 18S. The assessment is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 performed by local alignment using SortMeRNA with a permissive e-value
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 threshold.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 demultiplexed_seqs : SampleData[SequencesWithQuality | PairedEndSequencesWithQuality | JoinedSequencesWithQuality]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 The demultiplexed sequences to be denoised.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 reference_seqs : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 Positive filtering database. Keep all sequences aligning to these
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 trim_length : Int
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 Sequence trim length, specify -1 to disable trimming.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 left_trim_len : Int % Range(0, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 Sequence trimming from the 5' end. A value of 0 will disable this trim.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 sample_stats : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 If true, gather stats per sample.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 mean_error : Float, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 The mean per nucleotide error, used for original sequence estimate.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 indel_prob : Float, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 Insertion/deletion (indel) probability (same for N indels).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 indel_max : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 Maximum number of insertion/deletions.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 min_reads : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 Retain only features appearing at least min_reads times across all
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 samples in the resulting feature table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 min_size : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 In each sample, discard all features with an abundance less than
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 min_size.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 hashed_feature_ids : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 If true, hash the feature IDs.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 The resulting denoised feature table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 representative_sequences : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 The resulting feature sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 stats : DeblurStats
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 Per-sample stats if requested.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 </tool>