annotate qiime2/qiime_alignment_mask.xml @ 9:f190567fe3f6 draft

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