annotate qiime2/qiime_phylogeny_align-to-tree-mafft-fasttree.xml @ 10:21c7954105a9 draft

Fix
author florianbegusch
date Sun, 25 Aug 2019 10:26:27 -0400
parents f190567fe3f6
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_phylogeny_align-to-tree-mafft-fasttree" name="qiime phylogeny align-to-tree-mafft-fasttree" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Build a phylogenetic tree using fasttree and mafft alignment</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 phylogeny align-to-tree-mafft-fasttree
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-sequences=$isequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 #set $pnthreads = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #if str($pnthreads):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 --p-n-threads="$pnthreads"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18
4
florianbegusch
parents: 0
diff changeset
19 #if str($pmaskmaxgapfrequency):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 --p-mask-max-gap-frequency=$pmaskmaxgapfrequency
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22
4
florianbegusch
parents: 0
diff changeset
23 #if str($pmaskminconservation):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 --p-mask-min-conservation=$pmaskminconservation
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 --o-alignment=oalignment
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 --o-masked-alignment=omaskedalignment
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 --o-tree=otree
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 --o-rooted-tree=orootedtree
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 cp oalignment.qza $oalignment;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 cp omaskedalignment.qza $omaskedalignment;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 cp otree.qza $otree;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 cp orootedtree.qza $orootedtree
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 <param 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]" name="pmaskmaxgapfrequency" optional="True" type="float" min="0" max="1" exclusive_end="False" value="1.0"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 <param 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]" name="pmaskminconservation" optional="True" type="float" min="0" max="1" exclusive_end="False" value="0.4"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <data format="qza" label="${tool.name} on ${on_string}: alignment.qza" name="oalignment"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <data format="qza" label="${tool.name} on ${on_string}: maskedalignment.qza" name="omaskedalignment"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <data format="qza" label="${tool.name} on ${on_string}: tree.qza" name="otree"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <data format="qza" label="${tool.name} on ${on_string}: rootedtree.qza" name="orootedtree"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 Build a phylogenetic tree using fasttree and mafft alignment
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 ############################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 This pipeline will start by creating a sequence alignment using MAFFT,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 after which any alignment columns that are phylogenetically uninformative
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 or ambiguously aligned will be removed (masked). The resulting masked
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 alignment will be used to infer a phylogenetic tree and then subsequently
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 rooted at its midpoint. Output files from each step of the pipeline will be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 saved. This includes both the unmasked and masked MAFFT alignment from
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 q2-alignment methods, and both the rooted and unrooted phylogenies from
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 q2-phylogeny methods.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 sequences : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 The sequences to be used for creating a fasttree based rooted
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 phylogenetic tree.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 mask_max_gap_frequency : Float % Range(0, 1, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 The maximum relative frequency of gap characters in a column for the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 column to be retained. This relative frequency must be a number between
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 0.0 and 1.0 (inclusive), where 0.0 retains only those columns without
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 gap characters, and 1.0 retains all columns regardless of gap
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 character frequency. This value is used when masking the aligned
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 mask_min_conservation : Float % Range(0, 1, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 The minimum relative frequency of at least one non-gap character in a
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 column for that column to be retained. This relative frequency must be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 a number between 0.0 and 1.0 (inclusive). For example, if a value of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 0.4 is provided, a column will only be retained if it contains at
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 least one character that is present in at least 40% of the sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 This value is used when masking the aligned sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 alignment : FeatureData[AlignedSequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 The aligned sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 masked_alignment : FeatureData[AlignedSequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 The masked alignment.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 tree : Phylogeny[Unrooted]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 The unrooted phylogenetic tree.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 rooted_tree : Phylogeny[Rooted]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 The rooted phylogenetic tree.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 </tool>