annotate qiime_alignment_mask.xml @ 1:f2028d8efed6 draft default tip

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