box2: Alternative box function

In KevCaz/graphicsutils: Collection of graphics utilities

Alternative box function

Description

Draw a box around a plot.

Usage

box2(side, which = c("plot", "figure", "outer", "inner"), fill = NULL, ...)

Arguments

side	a numerical or character vector or a character string specifying which side(s) of the plot the box is to be drawn (see details).
which	a character, one of plot, figure, inner and outer.
fill	the color to be used to fill the box.
...	further graphical parameters (see graphics::par()) may also be supplied as arguments, particularly, line type, lty, line width, lwd, color, col and for type = 'b', pch. Also the line characteristics lend, ljoin and lmitre.

Details

This function intends to give more flexibility to the graphics::box() function. As which parameter, the user provides an object first coerced by as.character to a character string that is secondly split into single characters. For all of these characters, matches are sought with all elements of 1, 2, 3, 4, b, l, t, r where 1=below, 2=left, 3=above, 4=right, b=below, l=left, t=above and r=right.

See Also

graphics::box()

Examples

# Example 1:
plot0()
box2()

# Example 2:
plot0()
box2("14", fill = "grey80", lwd = 2)
plot0()
box2(c(1, 4), fill = "grey80", lwd = 2)
plot0()
box2(c(1, 4), fill = "grey80", lwd = 2)

# Example 3:
par(mfrow = c(2, 2), oma = c(2, 2, 2, 2))
plot0(0, 0)
box("outer", lwd = 2)
box("inner", lwd = 2)
plot.default(0, 0)
plot.default(0, 0)
plot0()
box2(which = "figure", lwd = 2, fill = 2)
box2(side = 12, lwd = 2, fill = 8)

KevCaz/graphicsutils documentation built on Sept. 16, 2022, 10:05 a.m.