controlChartMarkerLines: Creates a data.frame with the values provided to be used in...

In BenBruyneel/BBPersonalR: BBPersonalR

Creates a data.frame with the values provided to be used in the controlChart function as controlLines

Description

Creates a data.frame with the values provided to be used in the controlChart function as controlLines

Usage

controlChartMarkerLines(
  yValues = NA,
  type = "dashed",
  color = "blue",
  width = 1,
  alpha = 0.75
)

Arguments

yValues	a numeric vector specifying the 'heights' or y-axis values where a horizontal line is needed
type	linetype of the horizontal lines needed, either a single value or a vector of same length as yValues
color	color of the horizontal lines needed, either a single value or a vector of same length as yValues
width	width of the horizontal lines needed, either a single value or a vector of same length as yValues
alpha	alpha ('see through' value) of the horizontal lines needed, either a single value or a vector of same length as yValues

Note

if yValues == NA or empty then the function returns NA

@returns a data.frame with columns: yValues, type, color, width, alpha @export

BenBruyneel/BBPersonalR documentation built on Aug. 23, 2024, 8:28 p.m.