Vignetten voor R-pakketten ontwerpen

R-pakketten ontwikkelen

Jasmin Ludolf

Content Developer

Vignet-skelet maken

library(usethis)

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

name:

title: Wordt in de vignette zelf gebruikt

uitvoer van use_vignette()

uitvoer van use_vignette()

uitvoer van use_vignette()

uitvoer van use_vignette()

uitvoer van use_vignette()

uitvoer van use_vignette()

Vignet-skelet

Vignet-skelet

Vignet-skelet

Vignet-skelet

Vignette bijwerken

Vignette bijwerken

Vignette bijwerken

Vignette bijwerken

Vignette bijwerken

rmarkdown::render()
- Handig om syntaxis en voorbeelden te testen tijdens ontwikkeling
- Via de knop Knit HTML op DataCamp
devtools::build_vignettes()
- Formele toevoeging (van alle vignetten) aan het pakket
- Maakt ook een .R-bestand met alle R-code in de vignette
- Plaatst HTML-, .R- en .Rmd-bestanden in de map doc

R-pakketten ontwikkelen