Save a plot as SVG and/or PNG and queue for Inkscape conversion

Saves plot as an SVG file when save_svg = TRUE. When an SVG is saved, an Inkscape export action is also queued so PNG generation can be performed later in batch via export_pngs(). Optionally, when save_png = TRUE, the function also saves a PNG immediately via ggplot2::ggsave() (independently of queueing).

Usage

save_plot(
  file,
  plot,
  px_width = fundsr_get_option("px_width", 1300),
  height = 12,
  width = 12,
  units = "in",
  out_dir = fundsr_get_option("out_dir"),
  save_png = fundsr_get_option("internal_png", FALSE),
  save_svg = fundsr_get_option("export_svg", TRUE),
  background = "white"
)

Arguments

file

Base filename (without extension) used for output files.

plot

A plot object (typically a ggplot) to be saved.

px_width

Target width in pixels for PNG output. Used as the queued Inkscape export-width, and (if save_png = TRUE) used to compute the DPI for immediate PNG saving.

height

Height of the saved plot in units.

width

Width of the saved plot in units.

units

Units for width/height (e.g. "in"). For immediate PNG saving, only "in", "cm", and "mm" are supported (to compute DPI from px_width).

out_dir

Output directory where files are written.

save_png

Logical scalar; if TRUE, also saves a PNG immediately.

save_svg

Logical scalar; if TRUE, saves the SVG and queues an Inkscape export action.

background

Background color used for immediate PNG saving via ggplot2::ggsave() (bg).

Value

Invisibly returns NULL. Called for side effects.

Details

If save_svg = TRUE, the SVG is written as "{file}.svg". An Inkscape action string is then stored in .fundsr$inkscape_queue[file] so the SVG can later be exported to "{file}.png" at px_width pixels wide when export_pngs() is run.

Queueing is refused if either output path contains a semicolon (;), since Inkscape actions are separated by semicolons.

If save_png = TRUE, a PNG is also written immediately as "{file}.png". The PNG uses the same width, height, and units as the SVG, and sets dpi = px_width / width_in so that the pixel width is approximately px_width while keeping comparable physical-size typography across outputs. The PNG background is set via background.

If both save_svg and save_png are FALSE, the function issues a warning and returns without writing files or queueing exports.

See also

Other plot export utilities: clear_inkscape_queue(), export_pngs(), run_plots()