Builds package vignettes using the same algorithm that
R CMD build
does. This means including non-Sweave vignettes, using makefiles (if
present), and copying over extra files. The files are copied in the 'doc'
directory and an vignette index is created in 'Meta/vignette.rds', as they
would be in a built package. 'doc' and 'Meta' are added to
.Rbuildignore, so will not be included in the built package. These
files can be checked into version control, so they can be viewed with
vignette() if the package has been
load_all() without needing to re-build them locally.
build_vignettes(pkg = ".", dependencies = "VignetteBuilder", clean = TRUE, upgrade = "never", quiet = TRUE, install = TRUE, keep_md = TRUE)
package description, can be path or package name. See
Which dependencies do you want to check? Can be a character vector (selecting from "Depends", "Imports", "LinkingTo", "Suggests", or "Enhances"), or a logical vector.
Remove all files generated by the build, even if there were copies there before.
One of "ask", "always" or "never". "ask" prompts the user for
which out of date packages to upgrade. For non-interactive sessions "ask" is
equivalent to "always".