Boom: external.legend – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

external.legend

Add an external legend to an array of plots.

Description

ExternalLegendLayout sets up a plotting region to plot a regular grid of points, with an optional legend on the top or right of the grid.

AddExternalLegend adds a legend to a grid of plots that was set up using ExternalLegendLayout.

Usage

ExternalLegendLayout(nrow,
                     ncol,
                     legend.labels,
                     legend.location = c("top", "right"),
                     outer.margin.lines = rep(4, 4),
                     gap.between.plots = rep(0, 4),
                     legend.cex = 1,
                     x.axis = TRUE,
                     y.axis = TRUE)

AddExternalLegend(legend.labels,
                  legend.location = c("top", "right"),
                  legend.cex =1,
                  bty = "n",
                  ...)

Arguments

`nrow`	The number of rows in the array of plots.
`ncol`	The number of columns in the array of plots.
`legend.labels`	The labels to be used in the legend.
`legend.location`	Specifies whether the legend should appear on the top or the right hand side. It can also be `NULL`, indicating that no legend is desired.
`outer.margin.lines`	A vector of length four giving the number of lines of text desired for the outer margins of the plot. See the `oma` argument of `par`. This can also be specified as a single number, to be repeated 4 times.
`gap.between.plots`	A vector of length 4 giving the number of lines of text to leave between grid panels. See the `mar` argument of `par`. This can also be specified as a single number, to be repeated 4 times.
`legend.cex`	The scale factor that will be used for legend text. This must match the scale factor used in add.external.legend.
`x.axis`	Will any plots have a horizontal axis?
`y.axis`	Will any plots have a vertical axis?
`bty`	Type of box to draw around the legend. Can be "n" (for no box) or "o" for a box. See `legend`.
`...`	Extra arguments passed to `legend`.

Value

ExternalLegendLayout returns the original graphical parameters, intended for use with on.exit.

AddExternalLegend returns invisible NULL.

Author(s)

Steven L. Scott

Examples

example.plot <- function() {
  x <- rnorm(100)
  y <- rnorm(100)
  scale <- range(x, y)
  opar <- ExternalLegendLayout(nrow = 2,
                               ncol = 2,
                               legend.labels = c("foo", "bar"))
  on.exit({par(opar); layout(1)})
  hist(x, xlim = scale, axes = FALSE, main = "")
  mtext("X", side = 3, line = 1)
  box()
  plot(x, y, xlim = scale, ylim = scale, axes = FALSE)
  box()
  axis(3)
  axis(4)
  plot(y, x, xlim = scale, ylim = scale, axes = FALSE, pch = 2, col = 2)
  box()
  axis(1)
  axis(2)
  hist(y, xlim = scale, axes = FALSE, main = "")
  mtext("Y", side = 1, line = 1)
  box()
  AddExternalLegend(legend.labels = c("foo", "bar"),
                    pch = 1:2,
                    col = 1:2,
                    legend.cex = 1.5)
}

## Now call example.plot().
example.plot()

## Because of the call to on.exit(), in example.plot,
## the original plot layout is restored.
hist(1:10)

Boom

Bayesian Object Oriented Modeling

v0.9.7

LGPL-2.1 | file LICENSE

Authors

Steven L. Scott is the sole author and creator of the BOOM project. Some code in the BOOM libraries has been modified from other open source projects. These include Cephes (obtained from Netlib, written by Stephen L. Moshier), NEWUOA (M.J.D Powell, obtained from Powell's web site), and a modified version of the R math libraries (R core development team). Original copyright notices have been maintained in all source files. In these cases, copyright claimed by Steven L. Scott is limited to modifications made to the original code. Google claims copyright for code written while Steven L. Scott was employed at Google from 2008 - 2018, but BOOM is not an officially supported Google project.

Initial release

2021-02-15