annotate qiime2/qiime_gneiss_gradient-clustering.xml @ 9:f190567fe3f6 draft

Uploaded
author florianbegusch
date Wed, 14 Aug 2019 15:12:48 -0400
parents 51025741f326
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: 2
diff changeset
2 <tool id="qiime_gneiss_gradient-clustering" name="qiime gneiss gradient-clustering" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Hierarchical clustering using gradient information.</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 2
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 gneiss gradient-clustering
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --m-gradient-column="$mgradientcolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
9
f190567fe3f6 Uploaded
florianbegusch
parents: 2
diff changeset
14 #if $mgradientfile:
f190567fe3f6 Uploaded
florianbegusch
parents: 2
diff changeset
15 --m-gradient-file=$mgradientfile
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
16 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #if $pnoweighted:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 --p-no-weighted
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 --o-clustering=oclustering
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 cp oclustering.qza $oclustering
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency | RelativeFrequency | Composition] The feature table containing the samples in which the columns will be clustered. [required]" name="itable" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 <param label="--m-gradient-column: COLUMN MetadataColumn[Numeric] Contains gradient values to sort the features and samples. [required]" name="mgradientcolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 <param label="--p-no-weighted : Specifies if abundance or presence/absence information should be used to perform the clustering. [default: False]" name="pnoweighted" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30
9
f190567fe3f6 Uploaded
florianbegusch
parents: 2
diff changeset
31 <param label="--m-gradient-file: " name="mgradientfile" optional="True" type="data" format="tabular,qza,no_unzip.zip" />
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 <data format="qza" label="${tool.name} on ${on_string}: clustering.qza" name="oclustering"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 Hierarchical clustering using gradient information.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 ###################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 Build a bifurcating tree that represents a hierarchical clustering of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 features. The hiearchical clustering uses Ward hierarchical clustering
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 based on the mean difference of gradients that each feature is observed in.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 This method is primarily used to sort the table to reveal the underlying
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 block-like structures.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 table : FeatureTable[Frequency | RelativeFrequency | Composition]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 The feature table containing the samples in which the columns will be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 clustered.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 gradient : MetadataColumn[Numeric]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 Contains gradient values to sort the features and samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 weighted : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 Specifies if abundance or presence/absence information should be used
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 to perform the clustering.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 clustering : Hierarchy
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 A hierarchy of feature identifiers where each tip corresponds to the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 feature identifiers in the table. This tree can contain tip ids that
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 are not present in the table, but all feature ids in the table must be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 present in this tree.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 </tool>