[R] Color of box frame in Legend (Was: Matrix barplot)

Prof Brian Ripley ripley at stats.ox.ac.uk
Mon Jul 28 18:24:54 CEST 2008


The current default for the box/frame colour is not "black" (it is 
par("fg")), but otherwise I've committed something very similar to the 
R-devel version of R earlier today.

On Mon, 28 Jul 2008, Nutter, Benjamin wrote:

> Try sourcing in the 'new.legend' function below. It's the legend
> function with a new argument called 'box.col'.  The argument will change
> the color of the box surrounding the legend.  If I understand what it is
> you are looking for, this should work.  Also, I didn't see a way to
> change the axis bar in your code, so I suppressed the axis in the call
> to barplot, and manually replaced the axis using the axis function.  I
> hope this works for you.
>
> Benjamin
>
> data <- data.frame(Year=c(2000,2001,2002),
>                      A=c(2,2,1),
>                      B=c(3,1,2),
>                      C=c(0,3,5))
>
> data.mat <- as.matrix(data)[,2:4]
> rownames(data.mat) <- data[['Year']]
> data.mat <- t(data.mat)
>
> textcolor="yellow"
> par(col.axis=textcolor,col.main=textcolor)
>
> barplot(data.mat,beside=TRUE,col=rainbow(3),main="Test",yaxt="n")
> axis(2,at=0:5,col=textcolor)
> new.legend(x="topleft", colnames(data[,2:4]),fill=rainbow(3),
> inset=0.05,
>        text.col=textcolor,box.col=textcolor
>       )
>
>
> ########################################################################
> ###
> ########################################################################
> ###
> new.legend <- function (x, y = NULL, legend, fill = NULL, col =
> par("col"),
>    lty, lwd, pch, angle = 45, density = NULL, bty = "o", bg =
> par("bg"),
>    box.lwd = par("lwd"), box.lty = par("lty"), box.col="black",
>    pt.bg = NA, cex = 1,
>    pt.cex = cex, pt.lwd = lwd, xjust = 0, yjust = 1, x.intersp = 1,
>    y.intersp = 1, adj = c(0, 0.5), text.width = NULL, text.col =
> par("col"),
>    merge = do.lines && has.pch, trace = FALSE, plot = TRUE,
>    ncol = 1, horiz = FALSE, title = NULL, inset = 0)
> {
>    if (missing(legend) && !missing(y) && (is.character(y) ||
>        is.expression(y))) {
>        legend <- y
>        y <- NULL
>    }
>    mfill <- !missing(fill) || !missing(density)
>    title <- as.graphicsAnnot(title)
>    if (length(title) > 1)
>        stop("invalid title")
>    legend <- as.graphicsAnnot(legend)
>    n.leg <- if (is.call(legend))
>        1
>    else length(legend)
>    if (n.leg == 0)
>        stop("'legend' is of length 0")
>    auto <- if (is.character(x))
>        match.arg(x, c("bottomright", "bottom", "bottomleft",
>            "left", "topleft", "top", "topright", "right", "center"))
>    else NA
>    if (is.na(auto)) {
>        xy <- xy.coords(x, y)
>        x <- xy$x
>        y <- xy$y
>        nx <- length(x)
>        if (nx < 1 || nx > 2)
>            stop("invalid coordinate lengths")
>    }
>    else nx <- 0
>    xlog <- par("xlog")
>    ylog <- par("ylog")
>    rect2 <- function(left, top, dx, dy, density = NULL, angle,
>        ...) {
>        r <- left + dx
>        if (xlog) {
>            left <- 10^left
>            r <- 10^r
>        }
>        b <- top - dy
>        if (ylog) {
>            top <- 10^top
>            b <- 10^b
>        }
>        rect(left, top, r, b, angle = angle, density = density,
>            ...)
>    }
>    segments2 <- function(x1, y1, dx, dy, ...) {
>        x2 <- x1 + dx
>        if (xlog) {
>            x1 <- 10^x1
>            x2 <- 10^x2
>        }
>        y2 <- y1 + dy
>        if (ylog) {
>            y1 <- 10^y1
>            y2 <- 10^y2
>        }
>        segments(x1, y1, x2, y2, ...)
>    }
>    points2 <- function(x, y, ...) {
>        if (xlog)
>            x <- 10^x
>        if (ylog)
>            y <- 10^y
>        points(x, y, ...)
>    }
>    text2 <- function(x, y, ...) {
>        if (xlog)
>            x <- 10^x
>        if (ylog)
>            y <- 10^y
>        text(x, y, ...)
>    }
>    if (trace)
>        catn <- function(...) do.call("cat", c(lapply(list(...),
>            formatC), list("\n")))
>    cin <- par("cin")
>    Cex <- cex * par("cex")
>    if (is.null(text.width))
>        text.width <- max(abs(strwidth(legend, units = "user",
>            cex = cex)))
>    else if (!is.numeric(text.width) || text.width < 0)
>        stop("'text.width' must be numeric, >= 0")
>    xc <- Cex * xinch(cin[1], warn.log = FALSE)
>    yc <- Cex * yinch(cin[2], warn.log = FALSE)
>    if (xc < 0)
>        text.width <- -text.width
>    xchar <- xc
>    xextra <- 0
>    yextra <- yc * (y.intersp - 1)
>    ymax <- yc * max(1, strheight(legend, units = "user", cex = cex)/yc)
>    ychar <- yextra + ymax
>    if (trace)
>        catn("  xchar=", xchar, "; (yextra,ychar)=", c(yextra,
>            ychar))
>    if (mfill) {
>        xbox <- xc * 0.8
>        ybox <- yc * 0.5
>        dx.fill <- xbox
>    }
>    do.lines <- (!missing(lty) && (is.character(lty) || any(lty >
>        0))) || !missing(lwd)
>    n.legpercol <- if (horiz) {
>        if (ncol != 1)
>            warning("horizontal specification overrides: Number of
> columns := ",
>                n.leg)
>        ncol <- n.leg
>        1
>    }
>    else ceiling(n.leg/ncol)
>    if (has.pch <- !missing(pch) && length(pch) > 0) {
>        if (is.character(pch) && !is.na(pch[1]) && nchar(pch[1],
>            type = "c") > 1) {
>            if (length(pch) > 1)
>                warning("not using pch[2..] since pch[1] has multiple
> chars")
>            np <- nchar(pch[1], type = "c")
>            pch <- substr(rep.int(pch[1], np), 1:np, 1:np)
>        }
>        if (!merge)
>            dx.pch <- x.intersp/2 * xchar
>    }
>    x.off <- if (merge)
>        -0.7
>    else 0
>    if (is.na(auto)) {
>        if (xlog)
>            x <- log10(x)
>        if (ylog)
>            y <- log10(y)
>    }
>    if (nx == 2) {
>        x <- sort(x)
>        y <- sort(y)
>        left <- x[1]
>        top <- y[2]
>        w <- diff(x)
>        h <- diff(y)
>        w0 <- w/ncol
>        x <- mean(x)
>        y <- mean(y)
>        if (missing(xjust))
>            xjust <- 0.5
>        if (missing(yjust))
>            yjust <- 0.5
>    }
>    else {
>        h <- (n.legpercol + (!is.null(title))) * ychar + yc
>        w0 <- text.width + (x.intersp + 1) * xchar
>        if (mfill)
>            w0 <- w0 + dx.fill
>        if (has.pch && !merge)
>            w0 <- w0 + dx.pch
>        if (do.lines)
>            w0 <- w0 + (2 + x.off) * xchar
>        w <- ncol * w0 + 0.5 * xchar
>        if (!is.null(title) && (tw <- strwidth(title, units = "user",
>            cex = cex) + 0.5 * xchar) > w) {
>            xextra <- (tw - w)/2
>            w <- tw
>        }
>        if (is.na(auto)) {
>            left <- x - xjust * w
>            top <- y + (1 - yjust) * h
>        }
>        else {
>            usr <- par("usr")
>            inset <- rep(inset, length.out = 2)
>            insetx <- inset[1] * (usr[2] - usr[1])
>            left <- switch(auto, bottomright = , topright = ,
>                right = usr[2] - w - insetx, bottomleft = , left = ,
>                topleft = usr[1] + insetx, bottom = , top = ,
>                center = (usr[1] + usr[2] - w)/2)
>            insety <- inset[2] * (usr[4] - usr[3])
>            top <- switch(auto, bottomright = , bottom = , bottomleft =
> usr[3] +
>                h + insety, topleft = , top = , topright = usr[4] -
>                insety, left = , right = , center = (usr[3] +
>                usr[4] + h)/2)
>        }
>    }
>    if (plot && bty != "n") {
>        if (trace)
>            catn("  rect2(", left, ",", top, ", w=", w, ", h=",
>                h, ", ...)", sep = "")
>        rect2(left, top, dx = w, dy = h, col = bg, density = NULL,
>            lwd = box.lwd, lty = box.lty, border=box.col)
>    }
>    xt <- left + xchar + xextra + (w0 * rep.int(0:(ncol - 1),
>        rep.int(n.legpercol, ncol)))[1:n.leg]
>    yt <- top - 0.5 * yextra - ymax - (rep.int(1:n.legpercol,
>        ncol)[1:n.leg] - 1 + (!is.null(title))) * ychar
>    if (mfill) {
>        if (plot) {
>            fill <- rep(fill, length.out = n.leg)
>            rect2(left = xt, top = yt + ybox/2, dx = xbox, dy = ybox,
>                col = fill, density = density, angle = angle,
>                border = "black")
>        }
>        xt <- xt + dx.fill
>    }
>    if (plot && (has.pch || do.lines))
>        col <- rep(col, length.out = n.leg)
>    if (missing(lwd))
>        lwd <- par("lwd")
>    if (do.lines) {
>        seg.len <- 2
>        if (missing(lty))
>            lty <- 1
>        lty <- rep(lty, length.out = n.leg)
>        lwd <- rep(lwd, length.out = n.leg)
>        ok.l <- !is.na(lty) & (is.character(lty) | lty > 0)
>        if (trace)
>            catn("  segments2(", xt[ok.l] + x.off * xchar, ",",
>                yt[ok.l], ", dx=", seg.len * xchar, ", dy=0, ...)")
>        if (plot)
>            segments2(xt[ok.l] + x.off * xchar, yt[ok.l], dx = seg.len *
>
>                xchar, dy = 0, lty = lty[ok.l], lwd = lwd[ok.l],
>                col = col[ok.l])
>        xt <- xt + (seg.len + x.off) * xchar
>    }
>    if (has.pch) {
>        pch <- rep(pch, length.out = n.leg)
>        pt.bg <- rep(pt.bg, length.out = n.leg)
>        pt.cex <- rep(pt.cex, length.out = n.leg)
>        pt.lwd <- rep(pt.lwd, length.out = n.leg)
>        ok <- !is.na(pch) & (is.character(pch) | pch >= 0)
>        x1 <- (if (merge)
>            xt - (seg.len/2) * xchar
>        else xt)[ok]
>        y1 <- yt[ok]
>        if (trace)
>            catn("  points2(", x1, ",", y1, ", pch=", pch[ok],
>                ", ...)")
>        if (plot)
>            points2(x1, y1, pch = pch[ok], col = col[ok], cex =
> pt.cex[ok],
>                bg = pt.bg[ok], lwd = pt.lwd[ok])
>        if (!merge)
>            xt <- xt + dx.pch
>    }
>    xt <- xt + x.intersp * xchar
>    if (plot) {
>        if (!is.null(title))
>            text2(left + w/2, top - ymax, labels = title, adj = c(0.5,
>                0), cex = cex, col = text.col)
>        text2(xt, yt, labels = legend, adj = adj, cex = cex,
>            col = text.col)
>    }
>    invisible(list(rect = list(w = w, h = h, left = left, top = top),
>        text = list(x = xt, y = yt)))
> }
>
>
> ===================================
>
> P Please consider the environment before printing this e-mail
>
> Cleveland Clinic is ranked one of the top hospitals
> in America by U.S. News & World Report (2008).
> Visit us online at http://www.clevelandclinic.org for
> a complete listing of our services, staff and
> locations.
>
>
> Confidentiality Note:  This message is intended for use\...{{dropped:13}}
>
> ______________________________________________
> R-help at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-help
> PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
> and provide commented, minimal, self-contained, reproducible code.
>

-- 
Brian D. Ripley,                  ripley at stats.ox.ac.uk
Professor of Applied Statistics,  http://www.stats.ox.ac.uk/~ripley/
University of Oxford,             Tel:  +44 1865 272861 (self)
1 South Parks Road,                     +44 1865 272866 (PA)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595



More information about the R-help mailing list