Mercurial > repos > timpalpant > java_genomics_toolkit

annotate galaxy-conf/KMeans.xml @ 12:81d5b81fb3c2 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
author timpalpant
date Wed, 25 Apr 2012 16:53:48 -0400
parents b1952a90d4bf
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
1 <tool id="KMeans" name="KMeans cluster" version="1.0.0">
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
2 <description>an aligned matrix</description>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
3 <command interpreter="sh">galaxyToolRunner.sh visualization.KMeans -i $input -k $K -1 $min -2 $max -o $output</command>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
4 <inputs>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
5 <param format="tabular" name="input" type="data" label="Aligned matrix" />
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
6 <param name="K" type="integer" value="10" label="Number of clusters" />
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
7 <param name="min" type="integer" value="1" label="Minimum column to use for clustering" />
11
b1952a90d4bf Uploaded
timpalpant
parents: 4
diff changeset
8 <param name="max" type="integer" value="-1" label="Maximum column to use for clustering (-1 to end)" />
4
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
9 </inputs>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
10 <outputs>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
11 <data format="tabular" name="output" metadata="input" />
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
12 </outputs>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
13 <tests>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
14 </tests>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
15
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
16 <help>
12
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
17
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
18 .. class:: warningmark
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
19
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
20 This tool requires tabular data in matrix2png format (with column AND row headers). For more information about the required format and usage instructions, see the matrix2png_ website.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
21
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
22 .. _matrix2png: http://bioinformatics.ubc.ca/matrix2png/dataformat.html
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
23
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
24 .. class:: infomark
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
25
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
26 You can use the "Align values in a matrix" tool to create a matrix, then use this tool to cluster the matrix with k-means.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
27
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
28 .. class:: infomark
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
29
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
30 **TIP:** You can use the **min** and **max** columns to cluster a large matrix based on a subset of the columns. For example, you could cluster a 4000x4000 matrix on columns 200-300 by setting min = 200 and max = 300. This will greatly increase the efficiency of distance calculations during the k-means EM, and also allows you to cluster based on specific regions, such as promoters or coding sequences.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
31
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
32 -----
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
33
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
34 This tool will cluster the rows in an aligned matrix with KMeans_. The implementation builds upon the KMeansPlusPlusClusterer available in commons-math3_.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
35
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
36 .. _KMeans: http://en.wikipedia.org/wiki/K-means_clustering
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
37
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
38 .. _commons-math3: http://commons.apache.org/math/
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
39
4
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
40 </help>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
41 </tool>