Merge pull request #80 from vsimko/master

- parameter `win.asp` (issue #80)
- parameter `outline` combined with `method="pie"` (issue #18)
- updated vignette
- more unit tests

Author: vsimko

DESCRIPTION

@@ -1,13 +1,11 @@
 Package: corrplot
 Type: Package
 Title: Visualization of a Correlation Matrix
-Version: 0.80
-Date: 2016-11-14
+Version: 0.81
+Date: 2017-02-07
 Author: Taiyun Wei, Viliam Simko
 Suggests:
-    seriation,
     knitr,
-    Cairo,
     testthat
 Maintainer: Taiyun Wei <weitaiyun@gmail.com>
 Description: A graphical display of a correlation matrix or general matrix.
@@ -16,4 +14,4 @@ License: GPL
 URL: https://github.com/taiyun/corrplot
 BugReports: https://github.com/taiyun/corrplot/issues
 VignetteBuilder: knitr
-RoxygenNote: 5.0.1
+RoxygenNote: 6.0.1

R/corrplot.R

@@ -42,8 +42,9 @@
 #'   principal diagonal.
 #'
 #' @param outline Logical or character, whether plot outline of circles, square
-#'   and ellipse, or the color of these glyphs. If \code{outline} is
-#'   \code{TRUE}, the default value is \code{"black"}.
+#'   and ellipse, or the color of these glyphs. For pie, this represents the
+#'   color of the circle outlining the pie. If \code{outline} is \code{TRUE},
+#'   the default value is \code{"black"}.
 #'
 #' @param mar See \code{\link{par}}.
 #'
@@ -189,6 +190,9 @@
 #' @param na.label.col Color used for rendering \code{NA} cells. Default is
 #'   \code{"black"}.
 #'
+#' @param win.asp Aspect ration for the whole plot. Value other than 1 is
+#'   currently compatible only with methods "circle" and "square".
+#'
 #' @param \dots Additional arguments passing to function \code{text} for drawing
 #'   text lable.
 #'
@@ -259,6 +263,7 @@ corrplot <- function(corr,
   plotCI = c("n", "square", "circle", "rect"),
   lowCI.mat = NULL, uppCI.mat = NULL,
   na.label = "?", na.label.col = "black",
+  win.asp = 1,
   ...)
 {
 
@@ -271,6 +276,13 @@ corrplot <- function(corr,
   insig <- match.arg(insig)
   plotCI <- match.arg(plotCI)
 
+  # rescale symbols within the corrplot based on win.asp parameter
+  if (win.asp != 1 && !(method %in% c("circle", "square"))) {
+    stop("Parameter 'win.asp' is supported only for circle and square methods.")
+  }
+  asp_rescale_factor <- min(1, win.asp) / max(1, win.asp)
+  stopifnot(asp_rescale_factor >= 0 && asp_rescale_factor <= 1)
+
   if (!is.matrix(corr) && !is.data.frame(corr)) {
     stop("Need a matrix or data frame!")
   }
@@ -435,14 +447,14 @@ corrplot <- function(corr,
     ifelse(grepl("^[:=$]", s), parse(text = substring(s, 2)), s)
   }
 
-    newrownames <- sapply(
-      rownames(corr)[(n + 1 - n2):(n + 1 - n1)], expand_expression)
+  newrownames <- sapply(
+    rownames(corr)[(n + 1 - n2):(n + 1 - n1)], expand_expression)
 
-    newcolnames <- sapply(
-      colnames(corr)[m1:m2], expand_expression)
+  newcolnames <- sapply(
+    colnames(corr)[m1:m2], expand_expression)
 
-    DAT <- getPos.Dat(corr)[[2]]
-    len.DAT <- length(DAT)
+  DAT <- getPos.Dat(corr)[[2]]
+  len.DAT <- length(DAT)
 
   rm(expand_expression) # making sure the function is only used here
 
@@ -478,14 +490,12 @@ corrplot <- function(corr,
 
   if (isFALSE(outline)) {
     col.border <- col.fill
-  }
-
-  if (isTRUE(outline)) {
+  } else if (isTRUE(outline)) {
     col.border <- "black"
-  }
-
-  if (is.character(outline)) {
+  } else if (is.character(outline)) {
     col.border <- outline
+  } else {
+    stop("Unsupported value type for parameter outline")
   }
 
   oldpar <- par(mar = mar, bg = "white")
@@ -500,7 +510,7 @@ corrplot <- function(corr,
                 m2 + 0.5 + mm * cl.ratio * (cl.pos == "r"))
       ylim <- c(n1 - 0.5 - nn * cl.ratio * (cl.pos == "b"),
                 n2 + 0.5 + ylabwidth)
-      plot.window(xlim + c(-0.2,0.2), ylim + c(-0.2,0.2), asp = 1,
+      plot.window(xlim + c(-0.2, 0.2), ylim + c(-0.2, 0.2), asp = 1,
                   xaxs = "i", yaxs = "i")
       x.tmp <- max(strwidth(newrownames, cex = tl.cex))
       y.tmp <- max(strwidth(newcolnames, cex = tl.cex))
@@ -522,7 +532,7 @@ corrplot <- function(corr,
 
     laboffset <- strwidth("W", cex = tl.cex) * tl.offset
     xlim <- c(m1 - 0.5 - xlabwidth - laboffset,
-              m2 + 0.5 + mm * cl.ratio * (cl.pos == "r")) + c(-0.35,0.15)
+              m2 + 0.5 + mm * cl.ratio * (cl.pos == "r")) + c(-0.35, 0.15)
     ylim <- c(n1 - 0.5 - nn * cl.ratio * (cl.pos == "b"),
               n2 + 0.5 + ylabwidth * abs(sin(tl.srt * pi / 180)) + laboffset)
             + c(-0.15, 0.35)
@@ -533,21 +543,21 @@ corrplot <- function(corr,
     }
 
     plot.window(xlim = xlim , ylim = ylim,
-                asp = 1, xlab = "", ylab = "", xaxs = "i", yaxs = "i")
+                asp = win.asp, xlab = "", ylab = "", xaxs = "i", yaxs = "i")
   }
 
   ## for: add = TRUE
   laboffset <- strwidth("W", cex = tl.cex) * tl.offset
 
-  ## squares
+  ## background for the cells
   symbols(Pos, add = TRUE, inches = FALSE,
-          squares = rep(1, len.DAT), bg = bg, fg = bg)
+          rectangles = matrix(1, len.DAT, 2), bg = bg, fg = bg)
 
   ## circle
   if (method == "circle" && plotCI == "n") {
-      symbols(Pos, add = TRUE,  inches = FALSE,
-              circles = 0.9 * abs(DAT) ^ 0.5 / 2,
-              fg = col.border, bg = col.fill )
+    symbols(Pos, add = TRUE,  inches = FALSE,
+            circles = asp_rescale_factor * 0.9 * abs(DAT) ^ 0.5 / 2,
+            fg = col.border, bg = col.fill )
   }
 
   ## ellipse
@@ -556,7 +566,7 @@ corrplot <- function(corr,
       k <- seq(0, 2 * pi, length = length)
       x <- cos(k + acos(rho) / 2) / 2
       y <- cos(k - acos(rho) / 2) / 2
-      return(cbind(rbind(x,y), c(NA, NA)))
+      cbind(rbind(x,y), c(NA, NA))
     }
 
     ELL.dat <- lapply(DAT, ell.dat)
@@ -606,7 +616,10 @@ corrplot <- function(corr,
 
   ## pie
   if (method == "pie" && plotCI == "n") {
-    symbols(Pos, add = TRUE, inches = FALSE, circles = rep(0.5, len.DAT) * 0.85)
+
+    # Issue #18: Corrplot background circle
+    symbols(Pos, add = TRUE, inches = FALSE,
+            circles = rep(0.5, len.DAT) * 0.85, fg = col.border)
 
     pie.dat <- function(theta, length = 100) {
       k <- seq(pi / 2, pi / 2 - theta, length = 0.5 * length * abs(theta) / pi)
@@ -663,7 +676,8 @@ corrplot <- function(corr,
   ## square
   if (method == "square" && plotCI == "n") {
     symbols(Pos, add = TRUE, inches = FALSE,
-            squares = abs(DAT) ^ 0.5, bg = col.fill, fg = col.border)
+            squares = asp_rescale_factor * abs(DAT) ^ 0.5,
+            bg = col.fill, fg = col.border)
   }
 
   ## color
@@ -673,8 +687,8 @@ corrplot <- function(corr,
   }
 
   ## add grid
-  symbols(Pos, add = TRUE, inches = FALSE,  bg = NA,
-          squares = rep(1, len.DAT), fg = addgrid.col)
+  symbols(Pos, add = TRUE, inches = FALSE,  bg = NA, fg = addgrid.col,
+          rectangles = matrix(1, nrow = len.DAT, ncol = 2) )
 
   if (plotCI != "n") {
 
@@ -693,7 +707,7 @@ corrplot <- function(corr,
     uppNew      <- getPos.Dat(uppCI.mat)[[2]]
 
     if (!method %in% c("circle", "square")) {
-       stop("method shoud be circle or square if draw confidence interval!")
+       stop("Method shoud be circle or square if drawing confidence intervals.")
     }
 
     k1 <- (abs(uppNew) > abs(lowNew))

inst/CITATION

@@ -1,13 +1,13 @@
 bibentry("Manual",
 	title="R package 'corrplot': Visualization of a correlation matrix",
 	author="Taiyun Wei and Viliam Simko",
-	year="2016",
-	note="(Version 0.80)",
+	year="2017",
+	note="(Version 0.81)",
 	url="https://github.com/taiyun/corrplot",
 
 	textVersion =
   	paste("T. Wei and V. Simko (2016). ",
-  			"R package 'corrplot': Visualization of a correlation matrix (Version 0.80). ",
+  			"R package 'corrplot': Visualization of a correlation matrix (Version 0.81). ",
   			"Available from https://github.com/taiyun/corrplot",
   			sep=""),