BuildVignettes: Build Package Vignettes

In inlmisc: Miscellaneous Functions for the USGS INL Project Office

Description

Build package vignettes from their source files using the buildVignettes function. Writes the PDF and (or) HTML documents of the package vignettes, and their executable code files.

Usage

BuildVignettes(
  dir = getwd(),
  doc = file.path(dir, "inst/doc"),
  gs_quality = c("ebook", "printer", "screen", "none"),
  clean = TRUE,
  quiet = TRUE
)

Arguments

dir	'character' string. Path to a package's root source directory, by default the working directory. Its subdirectory ‘vignettes’ is searched for vignette source files.
doc	'character' string. Path to write the vignette output files, by default ‘inst/doc’ under the working directory.
gs_quality	'character' string. Quality of compacted PDF files, the options are "ebook" (150 dpi, default), "printer" (300 dpi), "screen" (72 dpi), and "none" (no compression). See compactPDF function for details.
clean	'logical' flag. Whether to remove all intermediate files generated by the build.
quiet	'logical' flag. Whether to suppress most output.

Value

Invisible NULL

Author(s)

J.C. Fisher, U.S. Geological Survey, Idaho Water Science Center

inlmisc documentation built on Jan. 25, 2022, 1:14 a.m.