Package 'sameplot'

Render a plot consistently across RStudio, saved files, and knitr output

Description

sameplot() renders plot to a temporary PNG using a ragg device and returns a knitr image include pointing to that PNG. This makes the displayed output consistent across interactive use and knitted documents. Optionally, when save = TRUE, the plot is also saved to file using a ragg device inferred from the file extension.

Usage

sameplot(
  plot,
  file = NULL,
  width = 6.4,
  height = 4.8,
  units = "in",
  background = "white",
  scaling = 1,
  bitsize = 8,
  res = 300,
  save = FALSE
)

Arguments

plot	A plot object. Typically a ggplot, but any object whose print() method draws to the active graphics device.
file	Output filename (relative or absolute). Must include an extension .png or .tif/.tiff. Required when save = TRUE.
width, height	Plot size.
units	Units for width and height (e.g., "in", "cm", "mm").
background	Background color passed to ragg devices.
scaling	Increase to make plot bigger within the same physical size.
bitsize	Record color as 8 bit or 16 bit. 16 bit may be useful for smoother gradients.
res	Resolution in pixels per inch passed to ragg devices.
save	Logical; if TRUE, also save the plot to file.

Details

When knitting to HTML (e.g., rmarkdown::html_document()), sameplot() requires the document to be self-contained so that the generated images are embedded in the output. Add this to your YAML:

output:
  html_document:
    self_contained: true

Value

An object returned by knitr::include_graphics() (rendered by knitr in HTML/PDF output).

See Also

• https://github.com/TomNaber/sameplot

Examples

p <- ggplot2::ggplot(mtcars, ggplot2::aes(wt, mpg)) +
  ggplot2::geom_point()

# Display via temporary PNG
sameplot(p)

# Save a PNG
sameplot(p,
  file = file.path(tempdir(), "mtcars.png"),
  save = TRUE
  )

# Save a TIFF with custom parameters
sameplot(
  p,
  file =  file.path(tempdir(), "mtcars.tiff"),
  width = 4,
  height = 6,
  background = "transparent",
  res = 600,
  save = TRUE
)

---