use_vignette: Create a vignette or article

Description Usage Arguments General setup See Also Examples

View source: R/vignette.R

Description

Creates a new vignette or article in vignettes/. Articles are a special type of vignette that appear on pkgdown websites, but are not included in the package itself (because they are added to .Rbuildignore automatically).

Usage

1
2
3

Arguments

name

Base for file name to use for new vignette. Should consist only of numbers, letters, _ and -. Lower case is recommended.

title

The title of the vignette.

General setup

See Also

The vignettes chapter of R Packages.

Examples

1
2
3
4
## Not run: 
use_vignette("how-to-do-stuff", "How to do stuff")

## End(Not run)

usethis documentation built on Oct. 25, 2021, 9:06 a.m.