annotate qiime2-2020.8/qiime_diversity_pcoa.xml @ 27:a917731ff917 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 12:59:12 +0000
parents d93d8888f0b0
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_pcoa" name="qiime diversity pcoa"
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Principal Coordinate Analysis</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 pcoa
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
10
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
11 --i-distance-matrix=$idistancematrix
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
12
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
13 #if str($pnumberofdimensions):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
14 --p-number-of-dimensions=$pnumberofdimensions
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
15 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
16 --o-pcoa=opcoa
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
17
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
18 #if str($examples) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
19 --examples=$examples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
20 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
21
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
22 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
23 cp opcoa.qza $opcoa
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
24
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
25 ]]></command>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
26 <inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
27 <param format="qza,no_unzip.zip" label="--i-distance-matrix: ARTIFACT DistanceMatrix The distance matrix on which PCoA should be computed. [required]" name="idistancematrix" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
28 <param label="--p-number-of-dimensions: INTEGER Range(1, None) Dimensions to reduce the distance matrix to. This number determines how many eigenvectors and eigenvalues are returned,and influences the choice of algorithm used to compute them. By default, uses the default eigendecomposition method, SciPy\'s eigh, which computes all eigenvectors and eigenvalues in an exact manner. For very large matrices, this is expected to be slow. If a value is specified for this parameter, then the fast, heuristic eigendecomposition algorithm fsvd is used, which only computes and returns the number of dimensions specified, but suffers some degree of accuracy loss, the magnitude of which varies across different datasets. [optional]" name="pnumberofdimensions" optional="False" type="text" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
29 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
30
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
31 </inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
32
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
33 <outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
34 <data format="qza" label="${tool.name} on ${on_string}: pcoa.qza" name="opcoa" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
35
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
36 </outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
37
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
38 <help><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
39 Principal Coordinate Analysis
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
40 ###############################################################
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
41
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
42 Apply principal coordinate analysis.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
43
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
44 Parameters
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
45 ----------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
46 distance_matrix : DistanceMatrix
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
47 The distance matrix on which PCoA should be computed.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
48 number_of_dimensions : Int % Range(1, None), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
49 Dimensions to reduce the distance matrix to. This number determines how
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
50 many eigenvectors and eigenvalues are returned,and influences the
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
51 choice of algorithm used to compute them. By default, uses the default
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
52 eigendecomposition method, SciPy's eigh, which computes all
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
53 eigenvectors and eigenvalues in an exact manner. For very large
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
54 matrices, this is expected to be slow. If a value is specified for this
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
55 parameter, then the fast, heuristic eigendecomposition algorithm fsvd
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
56 is used, which only computes and returns the number of dimensions
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
57 specified, but suffers some degree of accuracy loss, the magnitude of
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
58 which varies across different datasets.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
59
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
60 Returns
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
61 -------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
62 pcoa : PCoAResults
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
63 The resulting PCoA matrix.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
64 ]]></help>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
65 <macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
66 <import>qiime_citation.xml</import>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
67 </macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
68 <expand macro="qiime_citation"/>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
69 </tool>