annotate qiime2/qiime_alignment_mask.xml @ 2:149432539226 draft

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