Designing R package vignettes

Developing R Packages

Jasmin Ludolf

Content Developer

Create vignette skeleton

library(usethis)

use_vignette(name = "func_conversion",
             title = "Function Conversion Examples")

name:

title: Will be fed into the vignette itself

use_vignette() output

use_vignette() output

use_vignette() output

use_vignette() output

use_vignette() output

use_vignette() output

Vignette skeleton

Vignette skeleton

Vignette skeleton

Vignette skeleton

Update vignette

Update vignette

Update vignette

Update vignette

Update vignette

rmarkdown::render()
- Useful for testing syntax and examples during development
- Done using the Knit HTML button on DataCamp
devtools::build_vignettes()
- More formal addition (of all vignettes) to the package
- Also creates a .R file with all R code in the vignette
- Places resulting HTML, .R, and .Rmd files in doc directory

Developing R Packages