Skip to contents

Set up a Bar Chart Configuration

Source: R/config_bar.R
setup_BarConfig.Rd

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_BarConfig(
  x = NULL,
  y = NULL,
  stack = FALSE,
  horizontal = FALSE,
  palette = 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,
  bar_width = NULL,
  order = "input",
  legend_position = "top",
  legend_placement = "outside"
)

Arguments

x

Optional Character: Column holding the categories.

y

Optional Character: Columns holding the values, one series each.

stack

Logical: If TRUE, stack the series instead of grouping them.

horizontal

Logical: If TRUE, draw the bars horizontally.

palette

Optional Character: Series colors, overriding the theme palette for this chart. NULL uses the theme's.

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.

bar_width

Optional Numeric (0, Inf): Bar thickness in pixels. NULL lets ECharts size bars from the category spacing.

order

Character {"input", "increasing", "decreasing"}: Order categories by their total across series, retaining ties and placing missing totals last.

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

BarConfig object.

Author

EDG

Examples

draw(setup_BarConfig(x = "cyl", y = "mpg"), data = aggregate(mpg ~ cyl, mtcars, mean))