oaTemplate: Create a OA Plot Template

In oaPlots: OpenAnalytics Plots Package

Description

Create a OA Plot Template

Usage

oaTemplate(xlim, ylim, xgrid = NULL, ygrid = NULL, xlab = NULL,
  ylab = NULL, main = NULL, bgCol = gray(0.9), col.axis = gray(0.6),
  col.lab = gray(0.4), col.main = gray(0.3), cex.axis = 0.7,
  cex.lab = 1, cex.main = 1.5, xaxs = "r", yaxs = "r", add = FALSE,
  box = FALSE, box.col = "black", box.lwd = 1, ylabels = NULL,
  xlabels = NULL, buffer = 0, gridLabelBuffer = 0.01, ylabBuffer = 0.1,
  xlabBuffer = 0.08, mainBuffer = 0.07)

Arguments

xlim	x limits for the plot
ylim	y limits for the plot
xgrid	values at which to draw the x axis gridlines
ygrid	values at which to draw the y axis gridlines
xlab	a title for the x axis
ylab	a title for the y axis
main	an overall title for the plot
bgCol	background color for the plot
col.axis	color for the axis labels
col.lab	color for the xlab and ylab titles
col.main	color for the main title
cex.axis	size of the axis labels
cex.lab	size of the xlab and ylab titles
cex.main	size of the main title
xaxs	The style of axis interval calculation to be used for the x-axis. Possible values are "r", "i". Style "r" (regular) first extends the data range by 4 percent at each end and then finds an axis with pretty labels that fits within the extended range. Style "i" (internal) just finds an axis with pretty labels that fits within the original data range.
yaxs	The style of axis interval calculation to be used for the y-axis. See xaxs above.
add	A logical value specifying whether to add the template to an existing plot. If FALSE, a new plot will be created
box	binary specifying whether to draw a bounding box around the plot
box.col	color of the bounding box
box.lwd	width of the bounding box lines
ylabels	labels to print at the y tickmarks
xlabels	labels to print at the x tickmarks
buffer	optional buffer around all edges of the plot (as a percentage of the plot)
gridLabelBuffer	buffer between plot and grid labels (as a proportion of plotting range)
ylabBuffer	distance between plot and y-axis title, as proportion of total plot width
xlabBuffer	distance between plot and x-axis title, as proportion of total plot height
mainBuffer	distance between plot and main title, as proportion of total plot height

Value

none, objects are plotted to the current device

Author(s)

Jason Waddell

Examples

par(plt = c(0, 1, 0, 1))
oaTemplate(xlim = c(0, 10), ylim = c(20, 50), add = FALSE, xlab = "X Label", ylab = "Y Label",
		main = "Main Title")

Example output

Loading required package: oaColors

oaPlots documentation built on May 2, 2019, 6:46 a.m.