annotate qiime2/qiime_alignment_mask.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_alignment_mask" name="qiime alignment mask"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Positional conservation and gap filtering.</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 alignment mask
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
10
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
11 --i-alignment=$ialignment
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
12
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
13 --p-max-gap-frequency=$pmaxgapfrequency
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 --p-min-conservation=$pminconservation
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 --o-masked-alignment=omaskedalignment
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24 cp omaskedalignment.qza $omaskedalignment
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28 <param format="qza,no_unzip.zip" label="--i-alignment: ARTIFACT FeatureData[AlignedSequence] The alignment to be masked. [required]" name="ialignment" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 <param exclude_max="False" label="--p-max-gap-frequency: PROPORTION Range(0, 1, inclusive_end=True) The maximum relative frequency of gap characters in a column for the column to be retained. This relative frequency must be a number between 0.0 and 1.0 (inclusive), where 0.0 retains only those columns without gap characters, and 1.0 retains all columns regardless of gap character frequency. [default: 1.0]" max="1" min="0" name="pmaxgapfrequency" optional="True" type="float" value="1.0" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 <param exclude_max="False" label="--p-min-conservation: PROPORTION Range(0, 1, inclusive_end=True) The minimum relative frequency of at least one non-gap character in a column for that column to be retained. This relative frequency must be a number between 0.0 and 1.0 (inclusive). For example, if a value of 0.4 is provided, a column will only be retained if it contains at least one character that is present in at least 40% of the sequences. [default: 0.4]" max="1" min="0" name="pminconservation" optional="True" type="float" value="0.4" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36 <data format="qza" label="${tool.name} on ${on_string}: maskedalignment.qza" name="omaskedalignment" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41 Positional conservation and gap filtering.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 Mask (i.e., filter) unconserved and highly gapped columns from an
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45 alignment. Default min_conservation was chosen to reproduce the mask
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46 presented in Lane (1991).
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50 alignment : FeatureData[AlignedSequence]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 The alignment to be masked.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52 max_gap_frequency : Float % Range(0, 1, inclusive_end=True), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 The maximum relative frequency of gap characters in a column for the
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 column to be retained. This relative frequency must be a number between
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 0.0 and 1.0 (inclusive), where 0.0 retains only those columns without
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56 gap characters, and 1.0 retains all columns regardless of gap character
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 frequency.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58 min_conservation : Float % Range(0, 1, inclusive_end=True), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59 The minimum relative frequency of at least one non-gap character in a
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60 column for that column to be retained. This relative frequency must be
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61 a number between 0.0 and 1.0 (inclusive). For example, if a value of
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62 0.4 is provided, a column will only be retained if it contains at least
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 one character that is present in at least 40% of the sequences.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67 masked_alignment : FeatureData[AlignedSequence]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 The masked alignment.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
72 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
73 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
74 </tool>