annotate qiime2/qiime_gneiss_gradient-clustering.xml @ 2:51025741f326 draft

Uploaded
author florianbegusch
date Thu, 18 Jul 2019 12:19:15 -0400
parents 370e0b6e9826
children f190567fe3f6
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" ?>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_gneiss_gradient-clustering" name="qiime gneiss gradient-clustering" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Hierarchical clustering using gradient information.</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2019.4">qiime2</requirement>
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
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
14 #if $input_files_mgradientfile:
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #set $file_list = $file_list + ',' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 --m-gradient-file=$list_dict_to_string($input_files_mgradientfile)
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
23 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #if $pnoweighted:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 --p-no-weighted
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 --o-clustering=oclustering
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 cp oclustering.qza $oclustering
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 <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
35 <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
36 <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
37
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 <repeat name="input_files_mgradientfile" optional="False" title="--m-gradient-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 <param label="--m-gradient-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [required]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <data format="qza" label="${tool.name} on ${on_string}: clustering.qza" name="oclustering"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 Hierarchical clustering using gradient information.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 ###################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 Build a bifurcating tree that represents a hierarchical clustering of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 features. The hiearchical clustering uses Ward hierarchical clustering
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 based on the mean difference of gradients that each feature is observed in.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 This method is primarily used to sort the table to reveal the underlying
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 block-like structures.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 table : FeatureTable[Frequency | RelativeFrequency | Composition]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 The feature table containing the samples in which the columns will be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 clustered.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 gradient : MetadataColumn[Numeric]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 Contains gradient values to sort the features and samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 weighted : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 Specifies if abundance or presence/absence information should be used
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 to perform the clustering.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 clustering : Hierarchy
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 A hierarchy of feature identifiers where each tip corresponds to the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 feature identifiers in the table. This tree can contain tip ids that
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 are not present in the table, but all feature ids in the table must be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 present in this tree.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 </tool>