annotate qiime_diversity_beta-phylogenetic-alt.xml @ 0:09b7bcb72fa7 draft

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