annotate qiime2/qiime_quality-control_exclude-seqs.xml @ 0:51b9b6b57732 draft

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