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