Set up a Line Chart Configuration — setup

The seam between convenient input and a complete, validated object. Every argument is optional, which is what lets the published schema require nothing.

Usage

setup_LineConfig(
  x = NULL,
  y = NULL,
  group = NULL,
  blocks = NULL,
  smooth = FALSE,
  area = FALSE,
  points = TRUE,
  zoom = FALSE,
  palette = NULL,
  block_color = NULL,
  block_opacity = 0.2,
  pad = DEFAULT_PAD,
  square = FALSE,
  equal_axes = FALSE,
  xlim = NULL,
  ylim = NULL,
  xlab = NULL,
  ylab = NULL,
  title = NULL,
  margin_top = NULL,
  margin_right = NULL,
  margin_bottom = NULL,
  margin_left = NULL,
  dat_path = NULL,
  origin = NULL,
  writer = NULL,
  legend_position = "top",
  legend_placement = "outside"
)

Arguments

x: Optional Character: Column along the horizontal axis. A numeric column gets a value axis, a Date or POSIXct column a time axis with adaptively chosen labels, and any other column a category axis.
y: Optional Character: Columns to plot, one line each.
group: Optional Character: Column to group and color lines by. Splits a single y column into one line per level; cannot be combined with several y columns or with blocks.
blocks: Optional Character: Column whose contiguous runs shade vertical background bands.
smooth: Logical: Draw smoothed lines.
area: Logical: Fill the area under each line.
points: Logical: Show a marker at each data value.
zoom: Logical: Enable the zoom control.
palette: Optional Character: Series colors, overriding the theme palette for this chart. NULL uses the theme's.
block_color: Optional Character: Band colors.
block_opacity: Numeric [0, 1]: Band opacity.
pad: Numeric [0, Inf): Fraction of the data range to extend each axis by when the limits are not given.
square: Logical: If TRUE, draw the plotting box square – equal height and width in pixels, excluding axis labels and margins.
equal_axes: Logical: If TRUE, give one data unit the same size in pixels on both axes. Set with square for a plot that is both, such as an ROC curve; the two axes are then made to span the same interval. Requires a numeric x.
xlim, ylim: Optional Numeric: Axis limits, length 2. NULL derives them from the data, padded by pad. On a time axis xlim is in epoch milliseconds, the unit the chart positions by.
xlab, ylab: Optional Character: Axis labels. NULL derives them from the data.
title: Optional Character: Chart title. Declared here because it is the one property every chart type has; palette is not (four take a colormap instead), and axis labels and margins are cartesian-only.
margin_top, margin_right, margin_bottom, margin_left: Optional Integer [0, Inf): Plot margins in pixels.
dat_path: Optional Character: Path to the data, read at draw time. The serializable alternative to passing data to draw().
origin: Optional Named character: Where each value came from. Normally computed from which arguments were supplied; pass it only when restoring a config that already carries provenance.
writer: Optional Named character: Which interface wrote the config.
legend_position: Character {"top", "bottom", "left", "right", "top-left", "top-right", "bottom-left", "bottom-right"}: Legend anchor. Top/bottom anchors use horizontal rows; left/right anchors use a vertical column. Corner anchors align within the top or bottom row.
legend_placement: Character {"outside", "inside"}: Relation to the plotting area. Outside placement reserves space for the complete legend; inside placement overlays the data. Neither setting adds a missing legend.

Value

LineConfig object.

Author

EDG

Examples

draw(setup_LineConfig(x = "wt", y = "mpg"), data = mtcars[order(mtcars$wt), ])