annotate qiime2/qiime_diversity_beta.xml @ 9:f190567fe3f6 draft

Uploaded
author florianbegusch
date Wed, 14 Aug 2019 15:12:48 -0400
parents de4c22a52df4
children a0a8d77a991c
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" ?>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
2 <tool id="qiime_diversity_beta" name="qiime diversity beta" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Beta diversity</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
5 <requirement type="package" version="2019.7">qiime2</requirement>
0
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
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
6
florianbegusch
parents: 0
diff changeset
11
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --p-metric=$pmetric
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
6
florianbegusch
parents: 0
diff changeset
14 #if str($ppseudocount):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 --p-pseudocount=$ppseudocount
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #set $pnjobs = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #if str($pnjobs):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 --p-n-jobs="$pnjobs"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 --o-distance-matrix=odistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 cp odistancematrix.qza $odistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 <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
29 <param label="--p-metric: " name="pmetric" optional="False" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 <option value="kulsinski">kulsinski</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 <option value="wminkowski">wminkowski</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 <option value="correlation">correlation</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 <option value="hamming">hamming</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 <option value="canberra">canberra</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 <option value="canberra_adkins">canberra_adkins</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 <option value="sqeuclidean">sqeuclidean</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 <option value="sokalmichener">sokalmichener</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 <option value="cityblock">cityblock</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 <option value="braycurtis">braycurtis</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 <option value="matching">matching</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 <option value="russellrao">russellrao</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 <option value="cosine">cosine</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <option value="yule">yule</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <option value="euclidean">euclidean</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <option value="rogerstanimoto">rogerstanimoto</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <option value="seuclidean">seuclidean</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <option value="jaccard">jaccard</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <option value="sokalsneath">sokalsneath</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <option value="aitchison">aitchison</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <option value="chebyshev">chebyshev</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <option value="dice">dice</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <option value="mahalanobis">mahalanobis</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <param label="--p-pseudocount: INTEGER Range(1, None) A pseudocount to handle zeros for compositional metrics. This is ignored for other metrics. [default: 1]" name="ppseudocount" optional="True" type="integer" min="1" value="1"/>
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}: distancematrix.qza" name="odistancematrix"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 Beta diversity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 ##############
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 Computes a user-specified beta diversity metric for all pairs of samples in
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 a feature table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 The feature table containing the samples over which beta diversity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 should be computed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 metric : Str % Choices('sokalmichener', 'yule', 'russellrao', 'rogerstanimoto', 'aitchison', 'correlation', 'jaccard', 'cosine', 'euclidean', 'sqeuclidean', 'chebyshev', 'cityblock', 'matching', 'dice', 'mahalanobis', 'wminkowski', 'kulsinski', 'seuclidean', 'sokalsneath', 'canberra', 'canberra_adkins', 'hamming', 'braycurtis')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 The beta diversity metric to be computed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 pseudocount : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 A pseudocount to handle zeros for compositional metrics. This is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 ignored for other metrics.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 distance_matrix : DistanceMatrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 The resulting distance matrix.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 </tool>