This function adds a vignette in the folder vignettes/. It also adds
dependencies knitr and
rmarkdown in the
field Suggests of the DESCRIPTION file (if not already present in
fields Imports).
add_vignette(
filename = NULL,
title = NULL,
open = TRUE,
overwrite = FALSE,
quiet = FALSE
)A character of length 1. The name of the .Rmd file to be
created. If NULL (default ) the .Rmd file will be named pkg.Rmd
where pkg is your package name.
A character of length 1. The title of the vignette. If NULL
(default) the title will be Get started.
A logical value. If TRUE (default) the file is opened in the
editor.
A logical value. If this file is already present and
overwrite = TRUE, it will be erased and replaced. Default is FALSE.
A logical value. If TRUE messages are deleted. Default is
FALSE.
No return value.
Other create files:
add_citation(),
add_compendium(),
add_description(),
add_dockerfile(),
add_license(),
add_makefile(),
add_package_doc(),
add_readme_rmd(),
add_renv(),
add_testthat()
if (FALSE) {
## Default vignette ----
add_vignette()
## Default vignette ----
add_vignette(filename = "pkg", title = "Get started")
}