annotate qiime2-2020.8/qiime_phylogeny_robinson-foulds.xml @ 0:5c352d975ef7 draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:33:04 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_phylogeny_robinson-foulds" name="qiime phylogeny robinson-foulds"
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Calculate Robinson-Foulds distance between phylogenetic trees.</description>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
9 qiime phylogeny robinson-foulds
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
10
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
11 --i-trees=$itrees
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
12
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
13 #if str($plabels):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
14 --p-labels=$plabels
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
15 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
16 #if str($pmissingtips) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
17 --p-missing-tips=$pmissingtips
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
18 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
19
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
20 --o-distance-matrix=odistancematrix
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
21
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
22 #if str($examples) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
23 --examples=$examples
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
25
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
26 ;
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
27 cp odistancematrix.qza $odistancematrix
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
28
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
29 ]]></command>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
30 <inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
31 <param format="qza,no_unzip.zip" label="--i-trees: ARTIFACTS... List[Phylogeny[Rooted | Unrooted]] Phylogenetic trees to compare with Robinson-Foulds. Rooting information and branch lengths are ignored by this metric. [required]" name="itrees" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
32 <param label="--p-labels: TEXT... Labels to use for the tree names in the distance List[Str] matrix. If ommited, labels will be \'tree_n\' where \'n\' ranges from 1..N. The number of labels must match the number of trees. [optional]" name="plabels" optional="False" type="text" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
33 <param label="--p-missing-tips: " name="pmissingtips" optional="True" type="select">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
34 <option selected="True" value="None">Selection is Optional</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
35 <option value="error">error</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
36 <option value="intersect-all">intersect-all</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
37 </param>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
38 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
39
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
40 </inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
41
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
42 <outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
43 <data format="qza" label="${tool.name} on ${on_string}: distancematrix.qza" name="odistancematrix" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
44
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
45 </outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
46
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
47 <help><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
48 Calculate Robinson-Foulds distance between phylogenetic trees.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
49 ###############################################################
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
50
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
51 Calculate the Robinson-Foulds symmetric difference metric between two or
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
52 more phylogenetic trees.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
53
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
54 Parameters
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
55 ----------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
56 trees : List[Phylogeny[Rooted | Unrooted]]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
57 Phylogenetic trees to compare with Robinson-Foulds. Rooting information
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
58 and branch lengths are ignored by this metric.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
59 labels : List[Str], optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
60 Labels to use for the tree names in the distance matrix. If ommited,
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
61 labels will be "tree_n" where "n" ranges from 1..N. The number of
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
62 labels must match the number of trees.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
63 missing_tips : Str % Choices('error', 'intersect-all'), optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
64 How to handle tips that are not shared between trees. "error" will
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
65 raise an error if the set of tips is not identical between all input
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
66 trees. "intersect-all" will remove tips that are not shared between all
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
67 trees before computing distances beteen trees.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
68
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
69 Returns
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
70 -------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
71 distance_matrix : DistanceMatrix
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
72 The distances between trees as a symmetric matrix.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
73 ]]></help>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
74 <macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
75 <import>qiime_citation.xml</import>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
76 </macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
77 <expand macro="qiime_citation"/>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
78 </tool>