geom_draw: Layer with Grid or Function

In Yunuuuu/ggdraw: Draw with grob or function in ggplot2

Layer with Grid or Function

Description

Draw ggplot2 layer with a grod or function.

Usage

geom_draw(
  draw = grid::nullGrob(),
  type = NULL,
  mapping = NULL,
  data = NULL,
  stat = "identity",
  position = "identity",
  ...,
  inherit.aes = TRUE
)

Arguments

draw	Either a grob object or a function which accepts two arguments (data and coords) and returns a grob. data contains value from parameter data, coords is value that have already been transformed to the plot scales. It is important to note that the columns names for the data and coords come from the aesthetic mappings in the ggplot2 plot.
type	a scalar character of group or panel, group which draws geom with draw_group draws collective geoms that display multiple observations with one geometric object and panel which draws geom with draw_panel draws individual geoms that display a distinct graphical object for each observation (row). Default: group
mapping	Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.
data	The data to be displayed in this layer. There are three options: If NULL, the default, the data is inherited from the plot data as specified in the call to ggplot(). A data.frame, or other object, will override the plot data. All objects will be fortified to produce a data frame. See fortify() for which variables will be created. A function will be called with a single argument, the plot data. The return value must be a data.frame, and will be used as the layer data. A function can be created from a formula (e.g. ~ head(.x, 10)).
stat	The statistical transformation to use on the data for this layer, either as a ggproto Geom subclass or as a string naming the stat stripped of the stat_ prefix (e.g. "count" rather than "stat_count")
position	Position adjustment, either as a string naming the adjustment (e.g. "jitter" to use position_jitter), or the result of a call to a position adjustment function. Use the latter if you need to change the settings of the adjustment.
...	Other arguments passed on to ggplot2::layer(). These are often aesthetics, used to set an aesthetic to a fixed value, like colour = "red" or size = 3. They may also be parameters to the paired geom/stat. Other arguments of function draw can be passed here.
inherit.aes	If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders().

Details

If you want to combine the functionality of multiple geoms it can usually be achieved by preparing the data for each of the geoms inside the draw_*() call and send it off to the different geoms, collecting the output in a grid::gList (a list of grobs) if the call is draw_group() or a grid::gTree (a grob containing multiple children grobs) if the call is draw_panel().

Value

a ggplot2 layer object

Examples

ggdraw_text <- grid::textGrob(
  "ggdraw",
  x = c(0, 0, 0.5, 1, 1),
  y = c(0, 1, 0.5, 0, 1),
  hjust = c(0, 0, 0.5, 1, 1),
  vjust = c(0, 1, 0.5, 0, 1)
)
ggplot2::ggplot(data.frame(x = 1, y = 2)) +
  geom_draw(ggdraw_text)

Yunuuuu/ggdraw documentation built on Sept. 14, 2022, 8:02 p.m.