annotate qiime2/qiime_phylogeny_align-to-tree-mafft-raxml.xml @ 14:a0a8d77a991c draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:51:29 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_phylogeny_align-to-tree-mafft-raxml" name="qiime phylogeny align-to-tree-mafft-raxml"
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
4 <description>Build a phylogenetic tree using raxml and mafft alignment.</description>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
9 qiime phylogeny align-to-tree-mafft-raxml
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
10
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
11 --i-sequences=$isequences
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
12
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
13 #if str($pnthreads) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
14 --p-n-threads=$pnthreads
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
15 #end if
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
16
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
17 --p-mask-max-gap-frequency=$pmaskmaxgapfrequency
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
18
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
19 --p-mask-min-conservation=$pmaskminconservation
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
20
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
21 #if $pparttree:
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
22 --p-parttree
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
23 #end if
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
24
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
25 #if str($psubstitutionmodel) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
26 --p-substitution-model=$psubstitutionmodel
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
27 #end if
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
28
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
29 #if str($pseed):
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
30 --p-seed=$pseed
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
31 #end if
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
32 #if str($praxmlversion) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
33 --p-raxml-version=$praxmlversion
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
34 #end if
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
35
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
36 --o-alignment=oalignment
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
37
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
38 --o-masked-alignment=omaskedalignment
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
39
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
40 --o-tree=otree
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
41
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
42 --o-rooted-tree=orootedtree
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
43
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
44 #if str($examples) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
45 --examples=$examples
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
46 #end if
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
47
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
48 ;
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
49 cp orootedtree.qza $orootedtree
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
50
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
51 ]]></command>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
52 <inputs>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
53 <param format="qza,no_unzip.zip" label="--i-sequences: ARTIFACT FeatureData[Sequence] The sequences to be used for creating a iqtree based rooted phylogenetic tree. [required]" name="isequences" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
54 <param label="--p-n-threads: " name="pnthreads" optional="True" type="select">
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
55 <option selected="True" value="None">Selection is Optional</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
56 <option value="Int % Range(1">Int % Range(1</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
57 <option value="None">None</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
58 </param>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
59 <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" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
60 <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" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
61 <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. NOTE: if using this option, it is recomended that only the CAT-based substitution models of RAxML be considered for this pipeline. [default: False]" name="pparttree" selected="False" type="boolean" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
62 <param label="--p-substitution-model: " name="psubstitutionmodel" optional="True" type="select">
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
63 <option selected="True" value="None">Selection is Optional</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
64 <option value="GTRGAMMA">GTRGAMMA</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
65 <option value="GTRGAMMAI">GTRGAMMAI</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
66 <option value="GTRCAT">GTRCAT</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
67 <option value="GTRCATI">GTRCATI</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
68 </param>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
69 <param label="--p-seed: INTEGER Random number seed for the parsimony starting tree. This allows you to reproduce tree results. If not supplied then one will be randomly chosen. [optional]" name="pseed" optional="False" type="text" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
70 <param label="--p-raxml-version: " name="praxmlversion" optional="True" type="select">
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
71 <option selected="True" value="None">Selection is Optional</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
72 <option value="Standard">Standard</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
73 <option value="SSE3">SSE3</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
74 <option value="AVX2">AVX2</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
75 </param>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
76 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
77
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
78 </inputs>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
79
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
80 <outputs>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
81 <data format="qza" label="${tool.name} on ${on_string}: alignment.qza" name="oalignment" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
82 <data format="qza" label="${tool.name} on ${on_string}: maskedalignment.qza" name="omaskedalignment" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
83 <data format="qza" label="${tool.name} on ${on_string}: tree.qza" name="otree" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
84 <data format="qza" label="${tool.name} on ${on_string}: rootedtree.qza" name="orootedtree" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
85
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
86 </outputs>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
87
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
88 <help><![CDATA[
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
89 Build a phylogenetic tree using raxml and mafft alignment.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
90 ###############################################################
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
91
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
92 This pipeline will start by creating a sequence alignment using MAFFT,
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
93 after which any alignment columns that are phylogenetically uninformative
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
94 or ambiguously aligned will be removed (masked). The resulting masked
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
95 alignment will be used to infer a phylogenetic tree using RAxML, under the
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
96 specified substitution model, and then subsequently rooted at its midpoint.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
97 Output files from each step of the pipeline will be saved. This includes
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
98 both the unmasked and masked MAFFT alignment from q2-alignment methods, and
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
99 both the rooted and unrooted phylogenies from q2-phylogeny methods.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
100
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
101 Parameters
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
102 ----------
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
103 sequences : FeatureData[Sequence]
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
104 The sequences to be used for creating a iqtree based rooted
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
105 phylogenetic tree.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
106 n_threads : Int % Range(1, None) | Str % Choices('auto'), optional
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
107 The number of threads. (Use `all` to automatically use all available
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
108 cores. This value is used when aligning the sequences and creating the
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
109 tree with iqtree.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
110 mask_max_gap_frequency : Float % Range(0, 1, inclusive_end=True), optional
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
111 The maximum relative frequency of gap characters in a column for the
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
112 column to be retained. This relative frequency must be a number between
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
113 0.0 and 1.0 (inclusive), where 0.0 retains only those columns without
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
114 gap characters, and 1.0 retains all columns regardless of gap
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
115 character frequency. This value is used when masking the aligned
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
116 sequences.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
117 mask_min_conservation : Float % Range(0, 1, inclusive_end=True), optional
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
118 The minimum relative frequency of at least one non-gap character in a
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
119 column for that column to be retained. This relative frequency must be
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
120 a number between 0.0 and 1.0 (inclusive). For example, if a value of
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
121 0.4 is provided, a column will only be retained if it contains at
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
122 least one character that is present in at least 40% of the sequences.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
123 This value is used when masking the aligned sequences.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
124 parttree : Bool, optional
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
125 This flag is required if the number of sequences being aligned are
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
126 larger than 1000000. Disabled by default. NOTE: if using this option,
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
127 it is recomended that only the CAT-based substitution models of RAxML
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
128 be considered for this pipeline.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
129 substitution_model : Str % Choices('GTRGAMMA', 'GTRGAMMAI', 'GTRCAT', 'GTRCATI'), optional
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
130 Model of Nucleotide Substitution.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
131 seed : Int, optional
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
132 Random number seed for the parsimony starting tree. This allows you to
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
133 reproduce tree results. If not supplied then one will be randomly
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
134 chosen.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
135 raxml_version : Str % Choices('Standard', 'SSE3', 'AVX2'), optional
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
136 Select a specific CPU optimization of RAxML to use. The SSE3 versions
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
137 will run approximately 40% faster than the standard version. The AVX2
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
138 version will run 10-30% faster than the SSE3 version.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
139
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
140 Returns
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
141 -------
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
142 alignment : FeatureData[AlignedSequence]
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
143 The aligned sequences.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
144 masked_alignment : FeatureData[AlignedSequence]
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
145 The masked alignment.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
146 tree : Phylogeny[Unrooted]
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
147 The unrooted phylogenetic tree.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
148 rooted_tree : Phylogeny[Rooted]
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
149 The rooted phylogenetic tree.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
150 ]]></help>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
151 <macros>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
152 <import>qiime_citation.xml</import>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
153 </macros>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
154 <expand macro="qiime_citation"/>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
155 </tool>