add_vignette: Create a vignette document

In rcompendium: Create a Package or Research Compendium Structure

Create a vignette document

Description

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).

Usage

add_vignette(
  filename = NULL,
  title = NULL,
  open = TRUE,
  overwrite = FALSE,
  quiet = FALSE
)

Arguments

filename	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.
title	A character of length 1. The title of the vignette. If NULL (default) the title will be ⁠Get started⁠.
open	A logical value. If TRUE (default) the file is opened in the editor.
overwrite	A logical value. If this file is already present and overwrite = TRUE, it will be erased and replaced. Default is FALSE.
quiet	A logical value. If TRUE messages are deleted. Default is FALSE.

Value

No return value.

See Also

Other create files: add_citation(), add_code_of_conduct(), add_compendium(), add_contributing(), add_description(), add_dockerfile(), add_license(), add_makefile(), add_package_doc(), add_readme_rmd(), add_renv(), add_testthat()

Examples

## Not run: 
## Default vignette ----
add_vignette()

## Default vignette ----
add_vignette(filename = "pkg", title = "Get started")

## End(Not run)

rcompendium documentation built on Oct. 26, 2023, 5:08 p.m.