annotate qiime2-2020.8/qiime_diversity_beta-phylogenetic.xml @ 20:d93d8888f0b0 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 12:44:24 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity_beta-phylogenetic" name="qiime diversity beta-phylogenetic"
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Beta diversity (phylogenetic)</description>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
9 qiime diversity beta-phylogenetic
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
10
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
12
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
13 --i-phylogeny=$iphylogeny
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
14
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
15 --p-metric=$pmetric
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
16
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
17 #if str($pthreads) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
18 --p-threads=$pthreads
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
21 #if $pvarianceadjusted:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
22 --p-variance-adjusted
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
24
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
25 #if str($palpha):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
26 --p-alpha=$palpha
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
28 #if $pbypasstips:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
29 --p-bypass-tips
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
31
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
32 --o-distance-matrix=odistancematrix
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
33
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
34 #if str($examples) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
35 --examples=$examples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
37
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
38 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
39 cp odistancematrix.qza $odistancematrix
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
40
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
41 ]]></command>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
42 <inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
43 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency | RelativeFrequency | PresenceAbsence] The feature table containing the samples over which beta diversity should be computed. [required]" name="itable" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
44 <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" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
45 <param label="--p-metric: " name="pmetric" optional="False" type="select">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
46 <option value="weighted_unifrac">weighted_unifrac</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
47 <option value="unweighted_unifrac">unweighted_unifrac</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
48 <option value="weighted_normalized_unifrac">weighted_normalized_unifrac</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
49 <option value="generalized_unifrac">generalized_unifrac</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
50 </param>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
51 <param label="--p-threads: " name="pthreads" optional="True" type="select">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
52 <option selected="True" value="None">Selection is Optional</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
53 <option value="Int % Range(1">Int % Range(1</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
54 <option value="None">None</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
55 </param>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
56 <param label="--p-variance-adjusted: --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" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
57 <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="False" type="text" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
58 <param label="--p-bypass-tips: --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" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
59 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
60
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
61 </inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
62
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
63 <outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
64 <data format="qza" label="${tool.name} on ${on_string}: distancematrix.qza" name="odistancematrix" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
65
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
66 </outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
67
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
68 <help><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
69 Beta diversity (phylogenetic)
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
70 ###############################################################
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
71
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
72 Computes a user-specified phylogenetic beta diversity metric for all pairs
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
73 of samples in a feature table.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
74
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
75 Parameters
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
76 ----------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
77 table : FeatureTable[Frequency | RelativeFrequency | PresenceAbsence]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
78 The feature table containing the samples over which beta diversity
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
79 should be computed.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
80 phylogeny : Phylogeny[Rooted]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
81 Phylogenetic tree containing tip identifiers that correspond to the
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
82 feature identifiers in the table. This tree can contain tip ids that
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
83 are not present in the table, but all feature ids in the table must be
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
84 present in this tree.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
85 metric : Str % Choices('generalized_unifrac', 'weighted_normalized_unifrac', 'weighted_unifrac', 'unweighted_unifrac')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
86 The beta diversity metric to be computed.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
87 threads : Int % Range(1, None) | Str % Choices('auto'), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
88 The number of CPU threads to use in performing this calculation. May
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
89 not exceed the number of available physical cores. If threads = 'auto',
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
90 one thread will be created for each identified CPU core on the host.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
91 variance_adjusted : Bool, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
92 Perform variance adjustment based on Chang et al. BMC Bioinformatics
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
93 2011. Weights distances based on the proportion of the relative
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
94 abundance represented between the samples at a given node under
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
95 evaluation.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
96 alpha : Float % Range(0, 1, inclusive_end=True), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
97 This parameter is only used when the choice of metric is
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
98 generalized_unifrac. The value of alpha controls importance of sample
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
99 proportions. 1.0 is weighted normalized UniFrac. 0.0 is close to
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
100 unweighted UniFrac, but only if the sample proportions are
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
101 dichotomized.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
102 bypass_tips : Bool, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
103 In a bifurcating tree, the tips make up about 50% of the nodes in a
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
104 tree. By ignoring them, specificity can be traded for reduced compute
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
105 time. This has the effect of collapsing the phylogeny, and is analogous
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
106 (in concept) to moving from 99% to 97% OTUs
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
107
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
108 Returns
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
109 -------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
110 distance_matrix : DistanceMatrix
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
111 The resulting distance matrix.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
112 ]]></help>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
113 <macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
114 <import>qiime_citation.xml</import>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
115 </macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
116 <expand macro="qiime_citation"/>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
117 </tool>