diff Marea/marea_cluster.xml @ 34:1a97d1537623 draft

Lot of bug fixes
author bimib
date Sat, 26 Oct 2019 07:49:31 -0400
parents abf0bfe01c78
children 94c51690d40c
line wrap: on
line diff
--- a/Marea/marea_cluster.xml	Wed Oct 16 16:25:56 2019 -0400
+++ b/Marea/marea_cluster.xml	Sat Oct 26 07:49:31 2019 -0400
@@ -1,4 +1,4 @@
-<tool id="MaREA_cluester" name="Cluster Analysis" version="1.0.7">
+<tool id="MaREA_cluester" name="Cluster Analysis" version="1.0.8">
     <description></description>
     <macros>
         <import>marea_macros.xml</import>
@@ -34,6 +34,7 @@
         #if $data.clust_type == 'hierarchy':
         	--k_min ${data.k_min}
         	--k_max ${data.k_max}
+        	--silhouette ${data.silhouette}
       	#end if
         ]]>
     </command>
@@ -67,8 +68,9 @@
         		</conditional>   	
         	</when>
         	<when value="hierarchy">
-        		<param name="k_min" argument="--k_min" type="integer" min="2" max="99" value="3" label="Min number of clusters (k) to be tested" />
-        		<param name="k_max" argument="--k_max" type="integer" min="3" max="99" value="5" label="Max number of clusters (k) to be tested" />
+        		<param name="k_min" argument="--k_min" type="integer" min="2" max="20" value="2" label="Min number of clusters (k) to be tested" />
+        		<param name="k_max" argument="--k_max" type="integer" min="3" max="20" value="3" label="Max number of clusters (k) to be tested" />
+        		<param name="silhouette" argument="--silhouette" type="boolean" value="true" label="Draw the Silhouette plot from k-min to k-max"/>
         	</when>
 		</conditional>
     </inputs>
@@ -87,6 +89,63 @@
 What it does
 -------------
 
+The tool performs cluster analysis of any dataset, according to most used algorithms: K-means, agglomerative
+clustering and DBSCAN (Density Based Spatial Clustering of Applications with Noise).
+
+Accepted files are:
+    - Tabular files in which rows indicate different variables and columns different observations. The first row reports the observations’ labels.
+
+
+Example of input dataset:
+-------------------------
+
++----------+----------+----------+ 
+|TCGAA62670|TCGAA62671|TCGAA62672|   
++==========+==========+==========+  
+| 0.523167 | 0.371355 | 0.925661 |
++----------+----------+----------+   
+| 0.568765 | 0.765567 | 0.456789 |
++----------+----------+----------+    
+| 0.876545 | 0.768933 | 0.987654 |
++----------+----------+----------+
+| 0.456788 | 0.876543 | 0.876542 |  
++----------+----------+----------+    
+| 0.876543 | 0.786543 | 0.897654 | 
++----------+----------+----------+
+
+. 
+
+
+Options:
+--------
+
+The following clustering types can be chosen:
+    - K-means. This option requires the number of clusters (k) to be set. Different values of k can be tested.
+    - Agglomerative clustering. Different values of k can be set, to cut the resulting dendrogram.
+    - DBSCAN. The DBSCAN method chooses the number of clusters based on parameters that define when a region is to be considered dense. Custom parameters may be used, namely the maximum distance between two samples for one to be considered as in the neighborhood of the other and the number of samples in a neighborhood for a point to be considered as a core point.
+
+The tool generates:
+    - a tab-separated file: reporting the affiliation of each observation to a cluster. In case different numbers of clusters have been tested, the best cluster assignment is reported according to maximum average silhouette score. If desired, the elbow plot is generated, as well as silhouette plot for each k.
+    - a list of items, including: 1) the cluster assignment for each tested number of clusters 2) the dendrogram in case of agglomerative clustering 3) elbow and silhouete plots in case of k-means clustering.
+    - a log file (.txt).
+    
+    
+.. class:: infomark
+
+**TIP**: This tool has been conceived to cluster gene expression data, by using the RAS scores computed by the tool
+`MaREA`_ as feature
+
+.. class:: infomark
+
+**TIP**: If your data is not TAB delimited, use `Convert delimiters to TAB`_.
+
+
+
+@REFERENCE@
+
+.. _MaREA: https://www.biorxiv.org/content/early/2018/01/16/248724
+.. _Convert delimiters to TAB: https://usegalaxy.org/?tool_id=Convert+characters1&version=1.0.0&__identifer=6t22teyofhj
+
 
 ]]>
     </help>