usethis (version 1.2.0)

use_vignette: Create a vignette

Description

Performs general set up for vignettes and initializes a new individual vignette:

• Adds needed packages to DESCRIPTION

• Adds inst/doc to .gitignore so built vignettes aren't tracked

• Creates a new draft .Rmd vignette in vignettes/ and, if possible, opens it for editing

Usage

use_vignette(name)

Arguments

name

Base for file name to use for new vignette. Should consist only of numbers, letters, _ and -. I recommend using lower case.

Examples

# NOT RUN {
use_vignette("how-to-do-stuff")
# }