Concevoir des vignettes de packages R

Développer des packages R

Jasmin Ludolf

Content Developer

Créer l'ossature d'une vignette

library(usethis)

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

name:

Nom de fichier à utiliser pour la nouvelle vignette
Doit ne contenir que des chiffres, lettres, traits de soulignement et tirets
Minuscules recommandées

title : Sera intégré dans la vignette elle‑même

Sortie de use_vignette()

Sortie de use_vignette()

Sortie de use_vignette()

Sortie de use_vignette()

Sortie de use_vignette()

Sortie de use_vignette()

Sortie de use_vignette()

Sortie de use_vignette()

Sortie de use_vignette()

Sortie de use_vignette()

Sortie de use_vignette()

Sortie de use_vignette()

Ossature de vignette dans le fichier func_conversion.Rmd

Ossature de vignette

Ossature de vignette dans le fichier func_conversion.Rmd

Ossature de vignette

Ossature de vignette dans le fichier func_conversion.Rmd

Ossature de vignette

Ossature de vignette dans le fichier func_conversion.Rmd

Ossature de vignette

Rappel des bonnes pratiques pour les vignettes

Contenu clair et ciblé
Structure bien organisée
Exemples et cas d'usage engageants

Mettre à jour la vignette selon les bonnes pratiques

Mettre à jour la vignette

Mettre à jour la vignette selon les bonnes pratiques

Mettre à jour la vignette

Mettre à jour la vignette selon les bonnes pratiques

Mettre à jour la vignette

Mettre à jour la vignette selon les bonnes pratiques

Mettre à jour la vignette

Mettre à jour la vignette selon les bonnes pratiques

Mettre à jour la vignette

Deux façons de générer des vignettes

rmarkdown::render()
- Utile pour tester la syntaxe et les exemples pendant le développement
- Via le bouton Knit HTML sur DataCamp
devtools::build_vignettes()
- Ajout plus formel (de toutes les vignettes) au package
- Crée aussi un fichier .R avec tout le code R de la vignette
- Place les fichiers HTML, .R et .Rmd résultants dans le répertoire doc

Passons à la pratique !

Développer des packages R

Preparing Video For Download...