annotate qiime2/qiime_diversity_beta-phylogenetic.xml @ 7:85b520815e85 draft

Uploaded
author florianbegusch
date Tue, 13 Aug 2019 07:53:59 -0400
parents 370e0b6e9826
children f190567fe3f6
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" name="qiime diversity beta-phylogenetic" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Beta diversity (phylogenetic)</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 qiime diversity beta-phylogenetic
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-phylogeny=$iphylogeny
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --p-metric=$pmetric
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #set $pnjobs = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #if str($pnjobs):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 --p-n-jobs="$pnjobs"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #if $pvarianceadjusted:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 --p-variance-adjusted
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #if str($palpha):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 --p-alpha="$palpha"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #if $pbypasstips:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 --p-bypass-tips
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 --o-distance-matrix=odistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 cp odistancematrix.qza $odistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT 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
38 <param format="qza,no_unzip.zip" label="--i-phylogeny: ARTIFACT Phylogenetic tree containing tip identifiers that Phylogeny[Rooted] 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
39 <param label="--p-metric: " name="pmetric" optional="False" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 <option value="generalized_unifrac">generalized_unifrac</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 <option value="unweighted_unifrac">unweighted_unifrac</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 <option value="weighted_normalized_unifrac">weighted_normalized_unifrac</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <option value="weighted_unifrac">weighted_unifrac</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <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" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <param label="--p-alpha: PROPORTION Range(0, 1, inclusive_end=True) 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" min="0" max="1" exclude_max="False" type="float"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <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" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <data format="qza" label="${tool.name} on ${on_string}: distancematrix.qza" name="odistancematrix"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 Beta diversity (phylogenetic)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 #############################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 Computes a user-specified phylogenetic beta diversity metric for all pairs
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 of samples in a feature table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 The feature table containing the samples over which beta diversity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 should be computed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 phylogeny : Phylogeny[Rooted]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 Phylogenetic tree containing tip identifiers that correspond to the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 feature identifiers in the table. This tree can contain tip ids that
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 are not present in the table, but all feature ids in the table must be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 present in this tree.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 metric : Str % Choices('weighted_unifrac', 'generalized_unifrac', 'weighted_normalized_unifrac', 'unweighted_unifrac')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 The beta diversity metric to be computed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 variance_adjusted : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 Perform variance adjustment based on Chang et al. BMC Bioinformatics
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 2011. Weights distances based on the proportion of the relative
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 abundance represented between the samples at a given node under
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 evaluation.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 alpha : Float % Range(0, 1, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 This parameter is only used when the choice of metric is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 generalized_unifrac. The value of alpha controls importance of sample
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 proportions. 1.0 is weighted normalized UniFrac. 0.0 is close to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 unweighted UniFrac, but only if the sample proportions are
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 dichotomized.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 bypass_tips : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 In a bifurcating tree, the tips make up about 50% of the nodes in a
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 tree. By ignoring them, specificity can be traded for reduced compute
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 time. This has the effect of collapsing the phylogeny, and is analogous
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 (in concept) to moving from 99% to 97% OTUs
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 distance_matrix : DistanceMatrix % Properties('phylogenetic')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 The resulting distance matrix.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 </tool>