annotate qiime2/qiime_quality-filter_q-score.xml @ 29:3ba9833030c1 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 13:12:49 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_quality-filter_q-score" name="qiime quality-filter q-score"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Quality filter based on sequence quality scores.</description>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
9 qiime quality-filter q-score
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
10
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
11 --i-demux=$idemux
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
12
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
13 --p-min-quality=$pminquality
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 --p-quality-window=$pqualitywindow
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 --p-min-length-fraction=$pminlengthfraction
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 --p-max-ambiguous=$pmaxambiguous
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 --o-filtered-sequences=ofilteredsequences
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23 --o-filter-stats=ofilterstats
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 cp ofilterstats.qza $ofilterstats
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34 <param format="qza,no_unzip.zip" label="--i-demux: ARTIFACT SampleData[SequencesWithQuality | PairedEndSequencesWithQuality]¹ | SampleData[JoinedSequencesWithQuality]² The demultiplexed sequence data to be quality filtered. [required]" name="idemux" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 <param label="--p-min-quality: INTEGER The minimum acceptable PHRED score. All PHRED scores less that this value are considered to be low PHRED scores. [default: 4]" name="pminquality" optional="True" type="integer" value="4" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36 <param label="--p-quality-window: INTEGER The maximum number of low PHRED scores that can be observed in direct succession before truncating a sequence read. [default: 3]" name="pqualitywindow" optional="True" type="integer" value="3" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37 <param label="--p-min-length-fraction: NUMBER The minimum length that a sequence read can be following truncation and still be retained. This length should be provided as a fraction of the input sequence length. [default: 0.75]" name="pminlengthfraction" optional="True" type="float" value="0.75" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 <param label="--p-max-ambiguous: INTEGER The maximum number of ambiguous (i.e., N) base calls. This is applied after trimming sequences based on `min-length-fraction`. [default: 0]" name="pmaxambiguous" optional="True" type="integer" value="0" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 <data format="qza" label="${tool.name} on ${on_string}: filteredsequences.qza" name="ofilteredsequences" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45 <data format="qza" label="${tool.name} on ${on_string}: filterstats.qza" name="ofilterstats" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50 Quality filter based on sequence quality scores.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 This method filters sequence based on quality scores and the presence of
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 ambiguous base calls.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58 demux : SampleData[SequencesWithQuality | PairedEndSequencesWithQuality]¹ | SampleData[JoinedSequencesWithQuality]²
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59 The demultiplexed sequence data to be quality filtered.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60 min_quality : Int, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61 The minimum acceptable PHRED score. All PHRED scores less that this
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62 value are considered to be low PHRED scores.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 quality_window : Int, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64 The maximum number of low PHRED scores that can be observed in direct
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65 succession before truncating a sequence read.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66 min_length_fraction : Float, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67 The minimum length that a sequence read can be following truncation and
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 still be retained. This length should be provided as a fraction of the
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 input sequence length.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70 max_ambiguous : Int, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71 The maximum number of ambiguous (i.e., N) base calls. This is applied
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
72 after trimming sequences based on `min_length_fraction`.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
73
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
74 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
75 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
76 filtered_sequences : SampleData[SequencesWithQuality]¹ | SampleData[JoinedSequencesWithQuality]²
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
77 The resulting quality-filtered sequences.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
78 filter_stats : QualityFilterStats
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
79 Summary statistics of the filtering process.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
80 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
81 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
82 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
83 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
84 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
85 </tool>