renderBXP: Box Plot

In USGS-R/smwrGraphs: Graphing Functions

Box Plot

Description

Draws a box plot (support functions).

Usage

renderBoxPlot(xtoplot, stats, Box, explan, expz, yaxis.log = FALSE,
  yrange = c(NA, NA), xrange = range(xtoplot) + c(-1, 1),
  ylabels = "Auto", xlabels = "Auto", xlabels.rotate = FALSE,
  xtitle = "", ytitle = "", caption = "", margin = c(NA, NA, NA,
  NA))

renderBXP(x, width, z, draw.RL = TRUE, fill = "none")

Arguments

xtoplot	the x-axis locations for each boxplot.
stats	a list containing the statistics for the boxplots.
Box	a list containing the control info for the boxplots.
explan	a list containing the information for an explanation.
expz	a list containing the information for an explanation of the boxplot.
yaxis.log	logical, if TRUE, then use a log transform for the data and the y-axis.
yrange	set the y-axis range.
xrange	set the x-axis range.
ylabels	either "Auto," the approximate number of labels, or the actual labels to use for the y-axis.
xlabels	either "Auto" or the x-axis labels for each boxplot.
xlabels.rotate	logical, if TRUE, then rotate the x-axis labels by 90 degrees.
xtitle	the x-axis title (also called x-axis caption).
ytitle	the y-axis title (also called y-axis caption).
caption	the figure caption.
margin	the parameters of the margin of the plot area.
x	the x-coordinate for the box.
width	the width of the box in x-axis units.
z	a list containing the statistics for the individual boxplot.
draw.RL	logical, if TRUE, then draw the reporting level for the individual boxplot.
fill	a character string describing the fill color for the box or "none" for no fill.

Value

Information about the graph.

Note

The function renderBXP draws a single boxplot in a graph. The function renderBoxPlot is called from each method function for boxPlot to produce the boxplot.

See Also

boxPlot

USGS-R/smwrGraphs documentation built on Oct. 11, 2022, 6:11 a.m.