annotate qiime2/qiime_quality-control_exclude-seqs.xml @ 7:85b520815e85 draft

Uploaded
author florianbegusch
date Tue, 13 Aug 2019 07:53:59 -0400
parents a025a4a89e07
children f190567fe3f6
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" ?>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_quality-control_exclude-seqs" name="qiime quality-control exclude-seqs" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Exclude sequences by alignment</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2019.4">qiime2</requirement>
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 quality-control exclude-seqs
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-query-sequences=$iquerysequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-reference-sequences=$ireferencesequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 #if str($pmethod) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 --p-method=$pmethod
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16
5
a025a4a89e07 Uploaded
florianbegusch
parents: 0
diff changeset
17 #if str($ppercidentity):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 --p-perc-identity=$ppercidentity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #if str($pevalue):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 --p-evalue="$pevalue"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
5
a025a4a89e07 Uploaded
florianbegusch
parents: 0
diff changeset
25 #if str($ppercqueryaligned):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 --p-perc-query-aligned=$ppercqueryaligned
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #set $pthreads = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #if str($pthreads):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 --p-threads="$pthreads"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 --o-sequence-hits=osequencehits
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --o-sequence-misses=osequencemisses
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 cp osequencehits.qza $osequencehits;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 cp osequencemisses.qza $osequencemisses
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 <param format="qza,no_unzip.zip" label="--i-query-sequences: ARTIFACT FeatureData[Sequence] Sequences to test for exclusion [required]" name="iquerysequences" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 <param format="qza,no_unzip.zip" label="--i-reference-sequences: ARTIFACT FeatureData[Sequence] Reference sequences to align against feature sequences [required]" name="ireferencesequences" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <param label="--p-method: " name="pmethod" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <option value="blast">blast</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <option value="vsearch">vsearch</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <option value="blastn-short">blastn-short</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <param label="--p-perc-identity: PROPORTION Range(0.0, 1.0, inclusive_end=True) Reject match if percent identity to reference is lower. Must be in range [0.0, 1.0] [default: 0.97]" name="ppercidentity" optional="True" type="float" value="0.97" min="0" max="1" exclusive_end="False"/>
5
a025a4a89e07 Uploaded
florianbegusch
parents: 0
diff changeset
50 <param label="--p-evalue: NUMBER BLAST expectation (E) value threshold for saving hits. Reject if E value is higher than threshold. This threshold is disabled by default. [optional]" name="pevalue" optional="True" type="float"/>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <param label="--p-perc-query-aligned: NUMBER Percent of query sequence that must align to reference in order to be accepted as a hit. [default: 0.97]" name="ppercqueryaligned" optional="True" type="float" value="0.97"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <data format="qza" label="${tool.name} on ${on_string}: sequencehits.qza" name="osequencehits"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <data format="qza" label="${tool.name} on ${on_string}: sequencemisses.qza" name="osequencemisses"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 Exclude sequences by alignment
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 ##############################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 This method aligns feature sequences to a set of reference sequences to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 identify sequences that hit/miss the reference within a specified
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 perc_identity, evalue, and perc_query_aligned. This method could be used to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 define a positive filter, e.g., extract only feature sequences that align
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 to a certain clade of bacteria; or to define a negative filter, e.g.,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 identify sequences that align to contaminant or human DNA sequences that
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 should be excluded from subsequent analyses. Note that filtering is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 performed based on the perc_identity, perc_query_aligned, and evalue
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 thresholds (the latter only if method==BLAST and an evalue is set). Set
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 perc_identity==0 and/or perc_query_aligned==0 to disable these filtering
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 thresholds as necessary.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 query_sequences : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 Sequences to test for exclusion
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 reference_sequences : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 Reference sequences to align against feature sequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 method : Str % Choices('blast', 'vsearch', 'blastn-short'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 Alignment method to use for matching feature sequences against
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 reference sequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 perc_identity : Float % Range(0.0, 1.0, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 Reject match if percent identity to reference is lower. Must be in
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 range [0.0, 1.0]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 evalue : Float, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 BLAST expectation (E) value threshold for saving hits. Reject if E
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 value is higher than threshold. This threshold is disabled by default.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 perc_query_aligned : Float, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 Percent of query sequence that must align to reference in order to be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 accepted as a hit.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 sequence_hits : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 Subset of feature sequences that align to reference sequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 sequence_misses : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 Subset of feature sequences that do not align to reference sequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 </tool>