barplot2: barplot2

In raredd/plotr: More plotting functions and examples

barplot2

Description

Extension of barplot.default which accepts multi-way arrays and tables, simplifies grouping and spacing, and adds panel.first and panel.last functionality.

Usage

barplot2(
  height,
  width = 1,
  space = NULL,
  names.arg = NULL,
  legend.text = NULL,
  beside = FALSE,
  horiz = FALSE,
  density = NULL,
  angle = 45,
  col = NULL,
  border = par("fg"),
  main = NULL,
  sub = NULL,
  xlab = NULL,
  ylab = NULL,
  xlim = NULL,
  ylim = NULL,
  xpd = TRUE,
  log = "",
  axes = TRUE,
  axisnames = TRUE,
  cex.axis = par("cex.axis"),
  cex.names = par("cex.axis"),
  inside = TRUE,
  plot = TRUE,
  axis.lty = 0,
  offset = 0,
  add = FALSE,
  ann = !add && par("ann"),
  args.legend = NULL,
  panel.first = NULL,
  panel.last = NULL,
  ...
)

Arguments

height	a vector, matrix, table, or array; 1- or 2-D obects will produce barplot results; for 3-D tables and arrays, the third dimension will be a grouping variable in a stacked barplot
width	optional vector of bar widths. Re-cycled to length the number of bars drawn. Specifying a single value will have no visible effect unless xlim is specified.
space	the amount of space (as a fraction of the average bar width) left before each bar. May be given as a single number or one number per bar. If height is a matrix and beside is TRUE, space may be specified by two numbers, where the first is the space between bars in the same group, and the second the space between the groups. If not given explicitly, it defaults to c(0,1) if height is a matrix and beside is TRUE, and to 0.2 otherwise.
names.arg	a vector of names to be plotted below each bar or group of bars. If this argument is omitted, then the names are taken from the names attribute of height if this is a vector, or the column names if it is a matrix.
legend.text	a vector of text used to construct a legend for the plot, or a logical indicating whether a legend should be included. This is only useful when height is a matrix. In that case given legend labels should correspond to the rows of height; if legend.text is true, the row names of height will be used as labels if they are non-null.
beside	a logical value. If FALSE, the columns of height are portrayed as stacked bars, and if TRUE the columns are portrayed as juxtaposed bars.
horiz	a logical value. If FALSE, the bars are drawn vertically with the first bar to the left. If TRUE, the bars are drawn horizontally with the first at the bottom.
density	a vector giving the density of shading lines, in lines per inch, for the bars or bar components. The default value of NULL means that no shading lines are drawn. Non-positive values of density also inhibit the drawing of shading lines.
angle	the slope of shading lines, given as an angle in degrees (counter-clockwise), for the bars or bar components.
col	a vector of colors for the bars or bar components. By default, "grey" is used if height is a vector, and a gamma-corrected grey palette if height is a matrix; see grey.colors.
border	the color to be used for the border of the bars. Use border = NA to omit borders. If there are shading lines, border = TRUE means use the same colour for the border as for the shading lines.
main, sub	main title and subtitle for the plot.
xlab	a label for the x axis.
ylab	a label for the y axis.
xlim	limits for the x axis.
ylim	limits for the y axis.
xpd	logical. Should bars be allowed to go outside region?
log	string specifying if axis scales should be logarithmic; see plot.default.
axes	logical. If TRUE, a vertical (or horizontal, if horiz is true) axis is drawn.
axisnames	logical. If TRUE, and if there are names.arg (see above), the other axis is drawn (with lty = 0) and labeled.
cex.axis	expansion factor for numeric axis labels (see par('cex')).
cex.names	expansion factor for axis names (bar labels).
inside	logical. If TRUE, the lines which divide adjacent (non-stacked!) bars will be drawn. Only applies when space = 0 (which it partly is when beside = TRUE).
plot	logical. If FALSE, nothing is plotted.
axis.lty	the graphics parameter lty (see par('lty')) applied to the axis and tick marks of the categorical (default horizontal) axis. Note that by default the axis is suppressed.
offset	a vector indicating how much the bars should be shifted relative to the x axis.
add	logical specifying if bars should be added to an already existing plot; defaults to FALSE.
ann	logical specifying if the default annotation (main, sub, xlab, ylab) should appear on the plot, see title.
args.legend	list of additional arguments to pass to legend(); names of the list are used as argument names. Only used if legend.text is supplied.
panel.first, panel.last	expressions to be evaluated before or after plotting takes place
...	arguments to be passed to/from other methods. For the default method these can include further arguments (such as axes, asp and main) and graphical parameters (see par) which are passed to plot.window(), title() and axis.

Value

A list giving the locations of each bar, .$at, and the mid-point of each group, .$group.

Examples

set.seed(1)
x <- array(runif(4 * 3 * 3), c(4, 3, 3), dimnames = list(1:4, 1:3, 1:3))
barplot2(x, legend.text = TRUE)

barplot2(x[, , 1])
## compare
barplot(x[, , 1])

barplot2(with(mtcars, table(cyl, gear, vs)))


## group labels
barplot2(x, names.arg = list(A = 1:3, B = 4:6, C = 7:9))

## same but manually
bp <- barplot2(x, axisnames = FALSE, ann = FALSE)
mtext(1:9, side = 1L, at = bp$at, line = 1)
mtext(c('A', 'B', 'C'), side = 1L, at = bp$group, line = 3)


## simplified space argument
barplot2(
  x, space = c(0.1, 1, 2) / 2, las = 1L, col = 1:4,
  legend.text = sprintf('Factor %s', 1:4),
  args.legend = list(horiz = TRUE, bty = 'n'),
  names.arg = list(A = 1:3, B = 4:6, C = 7:9)
)


## extra features - panel.first, panel.last
barplot2(
  1:5,
  panel.first = {grid(0, NULL); abline(h = 4, col = 2)},
  panel.last  = {abline(h = 4.5, col = 3)}
)

raredd/plotr documentation built on Nov. 19, 2023, 4:09 a.m.