[R-gregmisc-users] SF.net SVN: r-gregmisc: [1051] trunk/gplots/man/textplot.Rd

[<wa...@us...>]

Revision: 1051
          http://svn.sourceforge.net/r-gregmisc/?rev=1051&view=rev
Author:   warnes
Date:     2007-02-08 14:03:16 -0800 (Thu, 08 Feb 2007)

Log Message:
-----------
Update documentation for textplot()

Modified Paths:
--------------
    trunk/gplots/man/textplot.Rd

Modified: trunk/gplots/man/textplot.Rd
===================================================================
--- trunk/gplots/man/textplot.Rd	2007-02-08 21:56:22 UTC (rev 1050)
+++ trunk/gplots/man/textplot.Rd	2007-02-08 22:03:16 UTC (rev 1051)
@@ -23,7 +23,9 @@
 \method{textplot}{matrix}(object, halign = c("center", "left", "right"),
          valign = c("center", "top", "bottom"), cex, cmar = 2,
          rmar = 0.5, show.rownames = TRUE, show.colnames = TRUE,
-         hadj = 1, vadj = 1, mar, ...)
+         hadj = 1, vadj = 1, mar = c(1, 1, 4, 1) + 0.1,
+         col.data = par("col"), col.rownames = par("col"), 
+         col.colnames = par("col"), ...) 
 }
 \arguments{
   \item{object}{Object to be displayed.}
@@ -51,6 +53,14 @@
   \item{hadj,vadj}{Vertical and horizontal location of elements within
     matrix cells.  These have the same meaning as the \code{adj} graphics
     paramter (see \code{\link{par}}).}
+  \item{col.data}{Colors for data elements.  If a single value is
+    provided, all data elements will be the same color.  If a matrix
+    matching the dimensions of the data is provided, each data element
+    will receive the specified color.}
+  \item{col.col.rownames, col.colnames}{Colors for row names and column
+    names, respectively.  Either may be specified as a scalar or a
+    vector of appropriate length.}
+  }
   \item{\dots}{ Optional arguments passed to the text plotting command
     or specialied object methods}
 }
@@ -106,6 +116,13 @@
 
 par(mfrow=c(1,1))
 
+# color control example
+cols <- c("red", "green", "magenta", "forestgreen")
+mat <- cbind(name=cols, t(col2rgb(cols)), hex=col2hex(cols))
+
+textplot(mat,
+         col.data=matrix(cols, nrow=length(cols), byrow=FALSE, ncol=5),
+         )
 }
 }
 \keyword{hplot}


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.