annotate qiime2/qiime_diversity_beta.xml @ 29:3ba9833030c1 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 13:12:49 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity_beta" name="qiime diversity beta"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Beta diversity</description>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
9 qiime diversity beta
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
10
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
12
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
13 --p-metric=$pmetric
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 --p-pseudocount=$ppseudocount
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 #if str($pnjobs) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18 --p-n-jobs=$pnjobs
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 --o-distance-matrix=odistancematrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28 cp odistancematrix.qza $odistancematrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32 <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" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 <param label="--p-metric: " name="pmetric" optional="False" type="select">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34 <option value="braycurtis">braycurtis</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 <option value="euclidean">euclidean</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36 <option value="cityblock">cityblock</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37 <option value="cosine">cosine</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 <option value="minkowski">minkowski</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39 <option value="matching">matching</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40 <option value="correlation">correlation</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41 <option value="russellrao">russellrao</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 <option value="sokalsneath">sokalsneath</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43 <option value="seuclidean">seuclidean</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 <option value="canberra">canberra</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45 <option value="sokalmichener">sokalmichener</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46 <option value="kulsinski">kulsinski</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 <option value="jensenshannon">jensenshannon</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48 <option value="jaccard">jaccard</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 <option value="hamming">hamming</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50 <option value="chebyshev">chebyshev</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 <option value="yule">yule</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52 <option value="dice">dice</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 <option value="sqeuclidean">sqeuclidean</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 <option value="aitchison">aitchison</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 <option value="canberra_adkins">canberra_adkins</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56 <option value="rogerstanimoto">rogerstanimoto</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 </param>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58 <param label="--p-pseudocount: INTEGER Range(1, None) A pseudocount to handle zeros for compositional metrics. This is ignored for other metrics. [default: 1]" min="1" name="ppseudocount" optional="True" type="integer" value="1" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59 <param label="--p-n-jobs: " name="pnjobs" optional="True" type="select">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60 <option selected="True" value="None">Selection is Optional</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61 <option value="Int % Range(1">Int % Range(1</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62 <option value="None">None</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 </param>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 <data format="qza" label="${tool.name} on ${on_string}: distancematrix.qza" name="odistancematrix" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
72
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
73 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
74 Beta diversity
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
75 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
76
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
77 Computes a user-specified beta diversity metric for all pairs of samples in
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
78 a feature table.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
79
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
80 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
81 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
82 table : FeatureTable[Frequency | RelativeFrequency | PresenceAbsence]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
83 The feature table containing the samples over which beta diversity
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
84 should be computed.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
85 metric : Str % Choices('yule', 'cityblock', 'matching', 'russellrao', 'seuclidean', 'jaccard', 'braycurtis', 'minkowski', 'sokalmichener', 'aitchison', 'canberra_adkins', 'euclidean', 'kulsinski', 'cosine', 'sqeuclidean', 'sokalsneath', 'correlation', 'hamming', 'dice', 'rogerstanimoto', 'canberra', 'chebyshev', 'jensenshannon')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
86 The beta diversity metric to be computed.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
87 pseudocount : Int % Range(1, None), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
88 A pseudocount to handle zeros for compositional metrics. This is
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
89 ignored for other metrics.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
90 n_jobs : Int % Range(1, None) | Str % Choices('auto'), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
91 The number of concurrent jobs to use in performing this calculation.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
92 May not exceed the number of available physical cores. If n_jobs =
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
93 'auto', one job will be launched for each identified CPU core on the
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
94 host.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
95
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
96 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
97 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
98 distance_matrix : DistanceMatrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
99 The resulting distance matrix.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
100 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
101 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
102 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
103 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
104 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
105 </tool>