ggwrite: Export plots created with ggplot (and more) or tables to...

In philipdelff/tracee: Easily Save Output and Trace it Back to Code

Export plots created with ggplot (and more) or tables to files (png or pdf) - or show them on screen.

Description

Export plots created with ggplot (and more) or tables to files (png or pdf) - or show them on screen.

Usage

ggwrite(
  plot,
  file,
  script,
  time,
  canvas = "standard",
  formats,
  onefile = FALSE,
  res = 200,
  paper = "special",
  save = TRUE,
  show = !save,
  useNames = FALSE,
  quiet = FALSE
)

Arguments

plot	A plot object or a list of plots. Normally generated with ggplot or qplot. But it can also be from grid.arrange or arrangeGrob with class gtable. That is experimental though. Not sure exactly what classes are supported.
file	A file to export to. Must end in .png or .pdf. If plot is a list, see onefile. If missing, plot is shown on screen.
script	This should normally be the path to your script. Requires ggplot >=2.2.1.
time	Passed to ggwrite.
canvas	Either a list of height and width or a shortname of predefined canvas size. See ?canvasSize.
formats	File formats to write to as a character vector. Must be a subset of c("png","pdf"). Default is to only write to the format matching the file name extension of file.
onefile	Only applicable if plot is a list. If plot is a list and onefile=TRUE, all plots will be put in a pdf (file must end in pdf) with one plot per page. If plot is a list and onefile=FALSE, numbered files will be created - one per list element.
res	Resolution. Passed to png.
paper	Only used with pdf device. See ?pdf.
save	Save the plot to the given file or just show? Defaults to TRUE. If a variable is used to control whether a script generates outputs (say writeOutputs=TRUE/FALSE), if you use save=writeOutputs to comply with this.
show	Print the plot to the screen? Defaults to the opposite of save. Hint, combining save and show in knitr can give you both a high quality plot in your pdf and a png optimized for powerpoint.
useNames	If length(plot)>1 use names(plot) in the file names? Default is to use 1:length(plot). Only used if save is TRUE, and length(plot)>1.
quiet	Default is false but use TRUE to suppress messages about what was saved.

Value

Nothing. Files written and/or plots shown, depending on argument values.

See Also

Other Plotting: canvasSize(), ggstamp(), ggwater()

Examples

library(ggplot2)
writeOutput <- FALSE
data(ChickWeight)
p1 <- ggplot(ChickWeight,aes(Time,weight,group=Chick,colour=factor(Diet)))+geom_line()
ggwrite(p1)  ## view plot on screen
script <- "note"
ggwrite(p1,script=script,canvas="wide",file="myplot1.png",save=writeOutput)

philipdelff/tracee documentation built on July 3, 2024, 2:21 p.m.