Preview ggplot in Specified Dimensions

This function previews a ggplot in its actual dimensions in order to see how it will look when saved. It is also significantly faster than the default preview in RStudio for ggplots created using cbbplotR. This is copied directly from nflplotR.

Usage

ggpreview(
  plot = ggplot2::last_plot(),
  width = NA,
  height = NA,
  asp = NULL,
  dpi = 300,
  device = "png",
  units = c("in", "cm", "mm", "px"),
  scale = 1,
  limitsize = TRUE,
  bg = NULL,
  ...
)

Arguments

plot: Plot to save, defaults to last plot displayed.
width, height: Plot size in units expressed by the units argument. If not supplied, uses the size of the current graphics device.
asp: The aspect ratio of the plot calculated as width / height. If this is a numeric value (and not NULL) the height of the plot will be recalculated to height = width / asp.
dpi: Plot resolution. Also accepts a string input: "retina" (320), "print" (300), or "screen" (72). Applies only to raster output types.
device: Device to use. Can either be a device function (e.g. png), or one of "eps", "ps", "tex" (pictex), "pdf", "jpeg", "tiff", "png", "bmp", "svg" or "wmf" (windows only). If NULL (default), the device is guessed based on the filename extension.
units: One of the following units in which the width and height arguments are expressed: "in", "cm", "mm" or "px".
scale: Multiplicative scaling factor.
limitsize: When TRUE (the default), ggsave() will not save images larger than 50x50 inches, to prevent the common error of specifying dimensions in pixels.
bg: Background colour. If NULL, uses the plot.background fill value from the plot theme.
...: Other arguments passed on to the graphics device function, as specified by device.

Value

No return value, called for side effects.