ggrastr (version 0.2.3)

rasterise: Rasterise ggplot layers Takes a ggplot layer as input and renders their graphical output as a raster.

Description

Rasterise ggplot layers Takes a ggplot layer as input and renders their graphical output as a raster.

Usage

rasterise(
  layer,
  dpi = getOption("ggrastr.default.dpi"),
  dev = "cairo",
  scale = 1
)
rasterize(
  layer,
  dpi = getOption("ggrastr.default.dpi"),
  dev = "cairo",
  scale = 1
)

Arguments

layer

A Layer object, typically constructed with a call to a geom_*() or stat_*() function.

dpi

integer Sets the desired resolution in dots per inch (default=NULL).

dev

string Specifies the device used, which can be one of: "cairo", "ragg" or "ragg_png" (default="cairo").

scale

numeric Scaling factor to modify the raster object size (default=1). The parameter 'scale=1' results in an object size that is unchanged, 'scale'>1 increase the size, and 'scale'<1 decreases the size. These parameters are passed to 'height' and 'width' of grid::grid.raster(). Please refer to 'rasterise()' and 'grid::grid.raster()' for more details.

Value

A modified Layer object.

Details

The default dpi (NULL (i.e. let the device decide)) can conveniently be controlled by setting the option "ggrastr.default.dpi" (e.g. option("ggrastr.default.dpi", 30) for drafting).

Examples

# NOT RUN {
require(ggplot2)
# `rasterise()` is used to wrap layers
ggplot(pressure, aes(temperature, pressure)) +
  rasterise(geom_line())

# The `dpi` argument controls resolution
ggplot(faithful, aes(eruptions, waiting)) +
  rasterise(geom_point(), dpi = 5)

# The `dev` argument offers a few options for devices
require(ragg)
ggplot(diamonds, aes(carat, depth, z = price)) +
  rasterise(stat_summary_hex(), dev = "ragg")

# The `scale` argument allows you to render a 'big' plot in small window, or vice versa.
ggplot(faithful, aes(eruptions, waiting)) +
  rasterise(geom_point(), scale = 4)

# }