annotate qiime2/qiime_gneiss_correlation-clustering.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_gneiss_correlation-clustering" name="qiime gneiss correlation-clustering"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Hierarchical clustering using feature correlation.</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 gneiss correlation-clustering
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-pseudocount=$ppseudocount
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 --o-clustering=oclustering
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22 cp oclustering.qza $oclustering
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] The feature table containing the samples in which the columns will be clustered. [required]" name="itable" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 <param label="--p-pseudocount: NUMBER The value to add to zero counts in the feature table. [default: 0.5]" name="ppseudocount" optional="True" type="float" value="0.5" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 <data format="qza" label="${tool.name} on ${on_string}: clustering.qza" name="oclustering" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 Hierarchical clustering using feature correlation.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41 Build a bifurcating tree that represents a hierarchical clustering of
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 features. The hiearchical clustering uses Ward hierarchical clustering
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43 based on the degree of proportionality between features.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 table : FeatureTable[Frequency]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48 The feature table containing the samples in which the columns will be
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 clustered.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50 pseudocount : Float, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 The value to add to zero counts in the feature table.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 clustering : Hierarchy
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56 A hierarchy of feature identifiers where each tip corresponds to the
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 feature identifiers in the table. This tree can contain tip ids that
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58 are not present in the table, but all feature ids in the table must be
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59 present in this tree.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65 </tool>