annotate cluster.tools/hclust.R @ 9:a3c03541fe6f draft default tip

Uploaded
author peter-waltman
date Mon, 11 Mar 2013 17:30:48 -0400
parents a58527c632b7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
1 #!/usr/bin/env Rscript
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
2
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
3 argspec <- c("hclust.R help TBD
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
4 \n\n")
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
5 args <- commandArgs(TRUE)
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
6 if ( length( args ) == 1 && args =="--help") {
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
7 write(argspec, stderr())
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
8 q();
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
9 }
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
10
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
11 lib.load.quiet <- function( package ) {
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
12 package <- as.character(substitute(package))
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
13 suppressPackageStartupMessages( do.call( "library", list( package=package ) ) )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
14 }
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
15 lib.load.quiet(getopt)
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
16 lib.load.quiet( amap )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
17 ## if any of the faster clustering methods are available on this system, load them
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
18 if ( any( c( 'flashClust', 'fastcluster' ) %in% installed.packages() ) ) {
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
19 if ( 'flashClust' %in% installed.packages() ) {
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
20 lib.load.quiet( flashClust )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
21 } else {
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
22 if ( 'fastcluster' %in% installed.packages() ) {
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
23 lib.load.quiet( fastcluster )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
24 }
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 spec <- matrix( c( "data.fname", "d", 1, "character",
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
29 "num.k", "k", 1, "integer",
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
30 "distance.metric", "m", 2, "character",
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
31 "dist.obj", "D", 2, "logical",
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
32 "direction", "n", 2, "character",
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
33 "linkage", "l", 2, "character",
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
34 "output.name", "o", 2, "character"
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
35 ),
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
36 nc=4,
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
37 byrow=TRUE
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
38 )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
39
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
40 opt <- getopt( spec=spec )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
41
8
a58527c632b7 Uploaded
peter-waltman
parents: 0
diff changeset
42 data <- as.matrix( read.delim( opt$data.fname, header=T, row.names=1 , check.names=FALSE ) )
0
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
43 if ( is.null( opt$distance.metric ) ) { opt$distance.metric <- "euclidean" }
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
44 if ( is.null( opt$dist.obj ) ) { opt$dist.obj <- FALSE }
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
45 if ( is.null( opt$direction ) ) { opt$direction <- "cols" }
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
46 if ( is.null( opt$linkage ) ) { opt$linkage <- "average" }
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
47 if ( is.null( opt$output.name ) ) { opt$output.name <- "hclust.result.rda" }
8
a58527c632b7 Uploaded
peter-waltman
parents: 0
diff changeset
48 if ( is.null( opt$num.k ) || ( opt$num.k == -1 )) {
a58527c632b7 Uploaded
peter-waltman
parents: 0
diff changeset
49 if ( opt$direction == 'cols' ) {
a58527c632b7 Uploaded
peter-waltman
parents: 0
diff changeset
50 opt$num.k <- 5
a58527c632b7 Uploaded
peter-waltman
parents: 0
diff changeset
51 } else if ( opt$direction == 'rows' ) {
a58527c632b7 Uploaded
peter-waltman
parents: 0
diff changeset
52 opt$num.k <- nrow( data ) / 30 ## we use an estimated average size of gene clusters to be 30
a58527c632b7 Uploaded
peter-waltman
parents: 0
diff changeset
53 if ( opt$num.k > 1000 ) {
a58527c632b7 Uploaded
peter-waltman
parents: 0
diff changeset
54 opt$num.k <- ( opt$num.k %/% 10 ) * 10
a58527c632b7 Uploaded
peter-waltman
parents: 0
diff changeset
55 } else {
a58527c632b7 Uploaded
peter-waltman
parents: 0
diff changeset
56 opt$num.k <- ( opt$num.k %/% 5 ) * 5
a58527c632b7 Uploaded
peter-waltman
parents: 0
diff changeset
57 }
a58527c632b7 Uploaded
peter-waltman
parents: 0
diff changeset
58 }
a58527c632b7 Uploaded
peter-waltman
parents: 0
diff changeset
59 }
0
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
60
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
61 if ( opt$direction == "cols" ) {
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
62 ## need to transpose b/c both kmeans & pam cluster the rows
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
63 ## this shouldn't have an effect upon a distance matrix
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
64 data <- t( data )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
65 }
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
66 if ( opt$num.k > nrow( data ) ) {
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
67 err.msg <- paste( "K specified is greater than the number of elements (", opt$direction, ") in data matrix to be clustereed\n", sep="" )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
68 stop( err.msg )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
69 }
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
70
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
71 if ( opt$dist.obj ) {
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
72 dist.mat <- as.dist( data )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
73 } else {
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
74 ## we're going to use the amap Dist function, but they misname their correlation
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
75 ## functions, so re-name them correctly
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
76 amap.distance <- c( "euclidean", "maximum", "manhattan", "canberra", "binary",
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
77 "pearson", "abspearson", "correlation", "abscorrelation", "spearman", "kendall" )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
78 names( amap.distance ) <- c( "euclidean", "maximum", "manhattan", "canberra", "binary",
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
79 "cosine", "abscosine", "pearson", "abspearson", "spearman", "kendall" )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
80
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
81 if ( ! opt$distance.metric %in% names( amap.distance ) ) stop("unsupported distance.")
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
82 dist.mat <- Dist( data, method=as.character( amap.distance[ opt$distance.metric ] ) )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
83 attr( dist.mat, "method" ) <- opt$distance.metric
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
84 }
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
85
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
86 ## now, do the clustering
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
87 treecl.res <- hclust( dist.mat, method=opt$linkage )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
88 cutree.res <- cutree( treecl.res, k=opt$num.k )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
89 ##cl <- cbind( names( cutree.res ), as.numeric( cutree.res ) )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
90 ##colnames( cl ) <- c( "ID", "class" )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
91
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
92 if ( opt$direction == "cols" ) {
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
93 ## need to re-transpose the data back to it's original dimensionality
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
94 data <- t( data )
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
95 }
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
96
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
97 cl <- cutree.res
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
98 save( file=opt$output.name, treecl.res, cl, data )