save_help_file_images: Save Rd File Images

In ddsjoberg/gt.doc.images: Save Help File Images

Save Rd File Images

Description

Only objects of class gtsummary, gt, or flextable will be saved. Object names must end in _ex or _ex[:digit:]

Usage

save_help_file_images(
  path = here::here(),
  pkg = basename(path),
  rd_files = NULL,
  delete_existing_pngs = NULL,
  path.output = file.path(path, "man", "figures"),
  run.dontrun = TRUE,
  run.donttest = TRUE
)

Arguments

path	path to package directory. Default is here::here()
pkg	Name of package. Default is the folder name in path=
rd_files	Character vector of Rd file names to search. Default is all Rd files. Include the .Rd extension in the file names.
delete_existing_pngs	Logical indicating whether to delete all png files in the ~/man/figures/ folder. Default is to ask interactively when rd_files = NULL. Otherwise, FALSE
path.output	directory where images will be saved. Default is file.path(path, "man", "figures")
run.dontrun	logical indicating that \dontrun should be ignored.
run.donttest	logical indicating that \donttest should be ignored.

ddsjoberg/gt.doc.images documentation built on Oct. 5, 2022, 10:16 a.m.