annotate qiime_gneiss_gradient-clustering.xml @ 1:f2028d8efed6 draft default tip

Add tool_data_table_conf.xml.sample
author florianbegusch
date Thu, 24 May 2018 03:40:50 -0400
parents 09b7bcb72fa7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_gneiss_gradient-clustering" name="qiime gneiss gradient-clustering" version="2018.4">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Hierarchical clustering using gradient information.</description>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2018.4">qiime2</requirement>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
7 <command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
8 <![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
9 qiime gneiss gradient-clustering --i-table=$itable --m-gradient-column="$mgradientcolumn"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
10
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
11 #def list_dict_to_string(list_dict):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
12 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
13 #for d in list_dict[1:]:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
14 #set $file_list = $file_list + ',' + d['additional_input'].__getattr__('file_name')
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
15 #end for
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
16 #return $file_list
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
17 #end def
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
18
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
19 --m-gradient-file=$list_dict_to_string($input_files_mgradientfile)
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
20 #if str($cmdconfig) != 'None':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
21 --cmd-config=$cmdconfig
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
22 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
23
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
24 #if $pweighted:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
25 --p-weighted
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
26 #else
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
27 --p-no-weighted
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
29
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
30 --o-clustering=oclustering;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
31 cp oclustering.qza $oclustering;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
32 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
33 </command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
34 <inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
35 <param format="qza,no_unzip.zip" label="--i-table: FeatureTable[Composition | Frequency | RelativeFrequency] The feature table containing the samples in which the columns will be clustered. [required]" name="itable" optional="False" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
36 <param label="--m-gradient-column: MetadataColumn[Numeric] Column from metadata file or artifact viewable as metadata. Contains gradient values to sort the features and samples. [required]" name="mgradientcolumn" optional="False" type="text"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
37
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
38 <repeat name="input_files_mgradientfile" optional="False" title="--m-gradient-file">
09b7bcb72fa7 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" />
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
40 </repeat>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
41
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
42 <param label="--p-weighted: --p-no-weighted Specifies if abundance or presence/absence information should be used to perform the clustering. [default: True]" name="pweighted" checked="True" type="boolean"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
43 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
44 </inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
45 <outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
46 <data format="qza" label="${tool.name} on ${on_string}: clustering.qza" name="oclustering"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
47 </outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
48 <help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
49 <![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
50 Hierarchical clustering using gradient information.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
51 ----------------------------------------------------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
52
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
53 Build a bifurcating tree that represents a hierarchical clustering of
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
54 features. The hiearchical clustering uses Ward hierarchical clustering
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
55 based on the mean difference of gradients that each feature is observed in.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
56 This method is primarily used to sort the table to reveal the underlying
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
57 block-like structures.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
58
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
59 Parameters
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
60 ----------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
61 table : FeatureTable[Composition | Frequency | RelativeFrequency]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
62 The feature table containing the samples in which the columns will be
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
63 clustered.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
64 gradient : MetadataColumn[Numeric]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
65 Contains gradient values to sort the features and samples.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
66 weighted : Bool, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
67 Specifies if abundance or presence/absence information should be used
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
68 to perform the clustering.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
69
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
70 Returns
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
71 -------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
72 clustering : Hierarchy
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
73 A hierarchy of feature identifiers where each tipcorresponds to the
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
74 feature identifiers in the table. This tree can contain tip ids that
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
75 are not present in the table, but all feature ids in the table must be
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
76 present in this tree.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
77 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
78 </help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
79 </tool>