annotate qiime2/qiime_diversity_beta-phylogenetic-alt.xml @ 3:558645416841 draft

Uploaded
author florianbegusch
date Sun, 21 Jul 2019 02:21:34 -0400
parents 370e0b6e9826
children
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" ?>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity_beta-phylogenetic-alt" name="qiime diversity beta-phylogenetic-alt" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Beta diversity (phylogenetic) - High Performance Computation</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2019.4">qiime2</requirement>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
8
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9 qiime diversity beta-phylogenetic-alt --i-table=$itable --i-phylogeny=$iphylogeny --p-metric=$pmetric
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 #if str($cmdconfig) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --cmd-config=$cmdconfig
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #if $pbypasstips:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 --p-bypass-tips
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #else
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 --p-no-bypass-tips
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #set $pnjobs = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #if str($pnjobs):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 --p-n-jobs="$pnjobs"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 --o-distance-matrix=odistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #if $pvarianceadjusted:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 --p-variance-adjusted
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 #else
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 --p-no-variance-adjusted
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 #if str($palpha):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 --p-alpha="$palpha"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 cp odistancematrix.qza $odistancematrix;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 <param format="qza,no_unzip.zip" label="--i-table: FeatureTable[Frequency] The feature table containing the samples over which beta diversity should be computed. [required]" name="itable" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <param format="qza,no_unzip.zip" label="--i-phylogeny: Phylogeny[Rooted] Phylogenetic tree containing tip identifiers that correspond to the feature identifiers in the table. This tree can contain tip ids that are not present in the table, but all feature ids in the table must be present in this tree. [required]" name="iphylogeny" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <param label="--p-metric: The beta diversity metric to be computed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 [required]" name="pmetric" optional="False" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <option selected="True" value="generalized_unifrac">generalized_unifrac</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <option value="weighted_unifrac">weighted_unifrac</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <option value="weighted_normalized_unifrac">weighted_normalized_unifrac</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <option value="unweighted_unifrac">unweighted_unifrac</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <param label="--p-variance-adjusted: --p-no-variance-adjusted Perform variance adjustment based on Chang et al. BMC Bioinformatics 2011. Weights distances based on the proportion of the relative abundance represented between the samples at a given node under evaluation. [default: False]" name="pvarianceadjusted" checked="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <param label="--p-alpha: This parameter is only used when the choice of metric is generalized_unifrac. The value of alpha controls importance of sample proportions. 1.0 is weighted normalized UniFrac. 0.0 is close to unweighted UniFrac, but only if the sample proportions are dichotomized. [optional]" name="palpha" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <param label="--p-bypass-tips: --p-no-bypass-tips In a bifurcating tree, the tips make up about 50% of the nodes in a tree. By ignoring them, specificity can be traded for reduced compute time. This has the effect of collapsing the phylogeny, and is analogous (in concept) to moving from 99% to 97% OTUs [default: False]" name="pbypasstips" checked="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <data format="qza" label="${tool.name} on ${on_string}: distance-matrix.qza" name="odistancematrix"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 Beta diversity (phylogenetic) - High Performance Computation
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 -------------------------------------------------------------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 Computes a user-specified phylogenetic beta diversity metric for all pairs
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 of samples in a feature table. This implementation is recommended for large
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 datasets, otherwise the results are identical to beta_phylogenetic. This
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 method is an implementation of the Strided State UniFrac algorithm.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 Multiple variants of the UniFrac metric are available, including
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 Generalized UniFrac (Chen et al. 2012), Variance Adjusted UniFrac (Chang et
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 al. 2011), as well as Weighted normalized and unnormalized UniFrac
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 (Lozupone et al. 2007) and unweighted UniFrac (Lozupone et al. 2005)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 The feature table containing the samples over which beta diversity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 should be computed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 phylogeny : Phylogeny[Rooted]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 Phylogenetic tree containing tip identifiers that correspond to the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 feature identifiers in the table. This tree can contain tip ids that
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 are not present in the table, but all feature ids in the table must be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 present in this tree.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 metric : Str % Choices({'generalized_unifrac', 'unweighted_unifrac', 'weighted_normalized_unifrac', 'weighted_unifrac'})
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 The beta diversity metric to be computed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 variance_adjusted : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 Perform variance adjustment based on Chang et al. BMC Bioinformatics
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 2011. Weights distances based on the proportion of the relative
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 abundance represented between the samples at a given node under
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 evaluation.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 alpha : Float % Range(0, 1, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 This parameter is only used when the choice of metric is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 generalized_unifrac. The value of alpha controls importance of sample
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 proportions. 1.0 is weighted normalized UniFrac. 0.0 is close to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 unweighted UniFrac, but only if the sample proportions are
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 dichotomized.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 bypass_tips : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 In a bifurcating tree, the tips make up about 50% of the nodes in a
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 tree. By ignoring them, specificity can be traded for reduced compute
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 time. This has the effect of collapsing the phylogeny, and is analogous
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 (in concept) to moving from 99% to 97% OTUs
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 distance_matrix : DistanceMatrix % Properties(['phylogenetic'])
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 The resulting distance matrix.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 ]]>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 </help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 <expand macro="qiime_citation" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 </tool>