layer_factory: Create a ggformula layer function

View source: R/layer_factory.R

layer_factoryR Documentation

Create a ggformula layer function

Description

Primarily intended for package developers, this function factory is used to create the layer functions in the ggformula package.

Usage

layer_factory(
  geom = "point",
  position = "identity",
  stat = "identity",
  pre = {
 },
  aes_form = y ~ x,
  extras = alist(),
  note = NULL,
  aesthetics = aes(),
  inherit.aes = TRUE,
  check.aes = TRUE,
  data = NULL,
  layer_fun = quo(ggplot2::layer),
  ...
)

Arguments

geom

The geom to use for the layer (may be specified as a string).

position

The position function to use for the layer (may be specified as a string).

stat

The stat function to use for the layer (may be specified as a string).

pre

code to run as a "pre-process".

aes_form

A single formula or a list of formulas specifying how attributes are inferred from the formula. Use NULL if the function may be used without a formula.

extras

An alist of additional arguments (potentially with defaults)

note

A note to add to the quick help.

aesthetics

Additional aesthetics (typically created using ggplot2::aes()) set rather than inferred from formula. gf_dhistogram() uses this to set the y aesthetic to stat(density), for example.

inherit.aes

A logical indicating whether aesthetics should be inherited from prior layers or a vector of character names of aesthetics to inherit.

check.aes

A logical indicating whether a warning should be emited when aesthetics provided don't match what is expected.

data

A data frame or NULL or NA.

layer_fun

The function used to create the layer or a quosure that evaluates to such a function.

...

Additional arguments.

Value

A function.


ggformula documentation built on Nov. 9, 2023, 5:08 p.m.