annotate qiime2-2020.8/qiime_phylogeny_align-to-tree-mafft-fasttree.xml @ 22:292c84bd5ab6 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 12:55:05 +0000
parents d93d8888f0b0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_phylogeny_align-to-tree-mafft-fasttree" name="qiime phylogeny align-to-tree-mafft-fasttree"
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Build a phylogenetic tree using fasttree and mafft alignment</description>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
9 qiime phylogeny align-to-tree-mafft-fasttree
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
10
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
11 --i-sequences=$isequences
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
12
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
13 #if str($pnthreads) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
14 --p-n-threads=$pnthreads
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
15 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
16
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
17 --p-mask-max-gap-frequency=$pmaskmaxgapfrequency
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
18
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
19 --p-mask-min-conservation=$pmaskminconservation
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
21 #if $pparttree:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
22 --p-parttree
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
24
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
25 --o-alignment=oalignment
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
26
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
27 --o-masked-alignment=omaskedalignment
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
28
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
29 --o-tree=otree
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
30
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
31 --o-rooted-tree=orootedtree
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
32
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
33 #if str($examples) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
34 --examples=$examples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
35 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
36
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
37 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
38 cp orootedtree.qza $orootedtree
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
39
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
40 ]]></command>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
41 <inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
42 <param format="qza,no_unzip.zip" label="--i-sequences: ARTIFACT FeatureData[Sequence] The sequences to be used for creating a fasttree based rooted phylogenetic tree. [required]" name="isequences" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
43 <param label="--p-n-threads: " name="pnthreads" optional="True" type="select">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
44 <option selected="True" value="None">Selection is Optional</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
45 <option value="Int % Range(1">Int % Range(1</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
46 <option value="None">None</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
47 </param>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
48 <param exclude_max="False" label="--p-mask-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. This value is used when masking the aligned sequences. [default: 1.0]" max="1" min="0" name="pmaskmaxgapfrequency" optional="True" type="float" value="1.0" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
49 <param exclude_max="False" label="--p-mask-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. This value is used when masking the aligned sequences. [default: 0.4]" max="1" min="0" name="pmaskminconservation" optional="True" type="float" value="0.4" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
50 <param label="--p-parttree: --p-parttree: / --p-no-parttree This flag is required if the number of sequences being aligned are larger than 1000000. Disabled by default. [default: False]" name="pparttree" selected="False" type="boolean" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
51 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
52
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
53 </inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
54
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
55 <outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
56 <data format="qza" label="${tool.name} on ${on_string}: alignment.qza" name="oalignment" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
57 <data format="qza" label="${tool.name} on ${on_string}: maskedalignment.qza" name="omaskedalignment" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
58 <data format="qza" label="${tool.name} on ${on_string}: tree.qza" name="otree" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
59 <data format="qza" label="${tool.name} on ${on_string}: rootedtree.qza" name="orootedtree" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
60
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
61 </outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
62
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
63 <help><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
64 Build a phylogenetic tree using fasttree and mafft alignment
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
65 ###############################################################
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
66
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
67 This pipeline will start by creating a sequence alignment using MAFFT,
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
68 after which any alignment columns that are phylogenetically uninformative
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
69 or ambiguously aligned will be removed (masked). The resulting masked
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
70 alignment will be used to infer a phylogenetic tree and then subsequently
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
71 rooted at its midpoint. Output files from each step of the pipeline will be
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
72 saved. This includes both the unmasked and masked MAFFT alignment from
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
73 q2-alignment methods, and both the rooted and unrooted phylogenies from
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
74 q2-phylogeny methods.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
75
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
76 Parameters
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
77 ----------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
78 sequences : FeatureData[Sequence]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
79 The sequences to be used for creating a fasttree based rooted
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
80 phylogenetic tree.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
81 n_threads : Int % Range(1, None) | Str % Choices('auto'), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
82 The number of threads. (Use `auto` to automatically use all available
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
83 cores) This value is used when aligning the sequences and creating the
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
84 tree with fasttree.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
85 mask_max_gap_frequency : Float % Range(0, 1, inclusive_end=True), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
86 The maximum relative frequency of gap characters in a column for the
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
87 column to be retained. This relative frequency must be a number between
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
88 0.0 and 1.0 (inclusive), where 0.0 retains only those columns without
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
89 gap characters, and 1.0 retains all columns regardless of gap
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
90 character frequency. This value is used when masking the aligned
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
91 sequences.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
92 mask_min_conservation : Float % Range(0, 1, inclusive_end=True), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
93 The minimum relative frequency of at least one non-gap character in a
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
94 column for that column to be retained. This relative frequency must be
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
95 a number between 0.0 and 1.0 (inclusive). For example, if a value of
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
96 0.4 is provided, a column will only be retained if it contains at
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
97 least one character that is present in at least 40% of the sequences.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
98 This value is used when masking the aligned sequences.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
99 parttree : Bool, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
100 This flag is required if the number of sequences being aligned are
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
101 larger than 1000000. Disabled by default.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
102
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
103 Returns
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
104 -------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
105 alignment : FeatureData[AlignedSequence]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
106 The aligned sequences.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
107 masked_alignment : FeatureData[AlignedSequence]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
108 The masked alignment.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
109 tree : Phylogeny[Unrooted]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
110 The unrooted phylogenetic tree.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
111 rooted_tree : Phylogeny[Rooted]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
112 The rooted phylogenetic tree.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
113 ]]></help>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
114 <macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
115 <import>qiime_citation.xml</import>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
116 </macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
117 <expand macro="qiime_citation"/>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
118 </tool>