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