annotate cluster.tools/cluster.2.centroid.xml @ 0:0decf3fd54bc draft

Uploaded
author peter-waltman
date Thu, 28 Feb 2013 01:45:39 -0500
parents
children 563832f48c08
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
1 <tool id="cluster_2_centroid" name="Calculate Matrix of Cluster Centroids (Mean Euclidean)" force_history_refresh="True">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
2 <command interpreter="python">cluster.2.centroid.py
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
3 -d $dataset
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
4 -g ${gen_new_dgram}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
5 -o ${output_fname}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
6
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
7 </command>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
8 <inputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
9 <param name="dataset" type="data" format='rdata' label="Cluster Result" help="Specify the cluster result to analayze (MUST BE IN rdata format; see help below)"/>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
10 <param name="gen_new_dgram" type='select' display="radio" label="Re-calculate cluster tree for new matrix ?" help="Specify whether or not to re-calculate a dendrogram for the cluster centroid matrix">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
11 <option value="no">No</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
12 <option value="yes" selected='true' >Yes</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
13 </param>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
14
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
15 </inputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
16 <outputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
17 <data format="rdata" name="output_fname" label="Cluster Centroid Matrix (RData)" />
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
18 </outputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
19 <help>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
20 .. class:: infomark
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
21
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
22 **Calculate Matrix of Cluster Centroids** - Tool to calculate a new matrix containing the cluster centroids, NOTE, this tool will automatically detect whether the dimensionality of the clusters (rows or columns).
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
23
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
24 **OUTPUT:** A new CDT file
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
25
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
26 ----
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
27
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
28 **Parameters**
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
29
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
30 - **Cluster Result** - Specify the cluster result to analayze (MUST BE IN rdata format), and must contain the same objects that are produced by the 'Partition Clustering,' 'Hierarchical Clustering (HAC),' or 'Consensus Clustering' tools. Specifically, it must contain the following objects
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
31
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
32 * A 'treecl.res' or 'partcl.res' object - corresponding to whether the cluster results is from a partition or tree clustering method
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
33 * A 'data' object that contains the data that was passed into the clustering method. NOTE, it is better for this to be the actual data passed in, rather than the data prior to the pre-processing that was performed prior to the actual clustering.
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
34
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
35 - **Re-calculate cluster tree for new matrix?** - Specify whether or not to re-calculate a dendrogram for the cluster centroid matrix.
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
36 * IF the cluster result was a tree cluster, the new dendrogram will use the distance method from the original clustering
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
37 * IF the cluster result was a partition cluster, the dendrogram will use 'Euclidean' distance
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
38
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
39
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
40 </help>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
41 </tool>