Aan de slag met R-pakketvignetten

R-pakketten ontwikkelen

Jasmin Ludolf

Content Developer

Structuur van een R-pakket

Doel van vignetten in R-pakketdocumentatie

• Geef gedetailleerde uitleg
• Benadruk praktische voorbeelden
• Bied volledige tutorials

Best practices voor vignetten

• Duidelijke, gefocuste inhoud
• Goede structuur
  • Duidelijke koppen en subkoppen
  • Tekst die R-code inleidt
  • Heldere R-code
  • Tekst die de resultaten bespreekt
• Pakkende voorbeelden en use-cases

Een R-pakketvignet doorbladeren

• Zoek best practices in vignetten van andere pakketten

browseVignettes("dplyr")

Een R-pakketvignet doorbladeren

• Zoek best practices in vignetten van andere pakketten

browseVignettes("dplyr")

HTML-versie van een vignet

bronversie van een vignet

bronversie van een vignet

YAML-header van bronversie van een vignet

 

Vignette-metadata

• Titel (title:) – vat de inhoud samen
• Output (output:) – type output, meestal rmarkdown::html_vignette
• Beschrijving (description: >) – overzicht van de inhoud
• Vignette: (vignette: >) – extra metadata, gebruikt %\ om items te starten

Vignetten versus artikelen

Vignette:

• Richt zich op pakketspecifieke functies
• Bevat hands-on voorbeelden
• Zit meestal in de packagedocumentatie

Artikel:

• Behandelt bredere onderwerpen of onderzoek
• Presenteert bevindingen of inzichten
• Wordt los van het pakket gepubliceerd

Laten we oefenen!

R-pakketten ontwikkelen