annotate qiime2-2020.8/qiime_diversity_pcoa.xml @ 0:5c352d975ef7 draft

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