Skip to contents

WebGL 2D Binned Rectangles

Source: R/geoms-webgl.R
geom_bin2d_webgl.Rd

Add a 2D binned layer tagged for the ggWebGL renderer. Binning is delegated to ggplot2::StatBin2d; the WebGL layer consumes the built rectangle boundaries and count/density metadata.

Usage

geom_bin2d_webgl(
  mapping = NULL,
  data = NULL,
  stat = "bin2d",
  position = "identity",
  ...,
  lineend = "butt",
  linejoin = "mitre",
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE
)

Arguments

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

Statistical transformation to use. Defaults to "bin2d" so ggplot2 computes two-dimensional bins before WebGL serialization.

position

A position adjustment to use on the data for this layer. This can be used in various ways, including to prevent overplotting and improving the display. The position argument accepts the following:

  • The result of calling a position function, such as position_jitter(). This method allows for passing extra arguments to the position.

  • A string naming the position adjustment. To give the position as a string, strip the function name of the position_ prefix. For example, to use position_jitter(), give the position as "jitter".

  • For more information and other ways to specify the position, see the layer position documentation.

...

Additional arguments forwarded through ggplot2::layer(), including ggplot2::stat_bin_2d() parameters such as bins, binwidth, breaks, and drop, plus static aesthetics.

lineend

Line end style (round, butt, square).

linejoin

Line join style (round, mitre, bevel).

na.rm

If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.

show.legend

logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. It can also be a named logical vector to finely select the aesthetics to display. To include legend keys for all levels, even when no data exists, use TRUE. If NA, all levels are shown in legend, but unobserved levels are omitted.

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. annotation_borders().

Value

A Layer ready for ggplot2.

Examples

bin_data <- data.frame(
  x = c(0.1, 0.2, 0.7, 1.2, 1.8, 2.1),
  y = c(0.1, 0.5, 0.6, 1.1, 1.3, 1.8)
)

ggplot2::ggplot(bin_data, ggplot2::aes(x, y)) +
  geom_bin2d_webgl(binwidth = c(1, 1))