Premiers pas avec les vignettes de packages R

Développer des packages R

Jasmin Ludolf

Content Developer

Structure d'un package R

Exemple de structure de package

Développer des packages R

Rôle des vignettes dans la documentation d'un package R

  • Donner des explications détaillées
  • Mettre en avant des exemples pratiques
  • Proposer des tutoriels complets

Déclic grâce à la documentation

Développer des packages R

Bonnes pratiques pour les vignettes

  • Contenu clair et ciblé
  • Structure bien organisée
    • Titres et sous-titres explicites
    • Texte résumant le code R à venir
    • Code R simple et direct
    • Texte analysant les résultats du code R
  • Exemples et cas d'usage engageants

Image de documentation

Développer des packages R

Parcourir une vignette de package R

  • Trouver de bons exemples dans les vignettes d'autres packages
browseVignettes("dplyr")

Page des vignettes dplyr

Développer des packages R

Parcourir une vignette de package R

  • Trouver de bons exemples dans les vignettes d'autres packages
browseVignettes("dplyr")

Page des vignettes dplyr

Développer des packages R

Version HTML d'une vignette

Vignette HTML de dplyr

Développer des packages R

Version source d'une vignette

Sélection du lien « source »

Développer des packages R

Version source d'une vignette

Code source de la vignette

Développer des packages R

En-tête YAML de la version source d'une vignette

 

Zoom sur l'en-tête du code source

Développer des packages R

Métadonnées d'une vignette

Métadonnées : analogie photo de chat

  • Title (title:) : résume le contenu de la vignette
  • Output (output:) : type de sortie, rmarkdown::html_vignette est le plus courant
  • Description (description: >) : aperçu du contenu
  • Vignette : (vignette: >) : métadonnées supplémentaires, utilise %\ pour démarrer les entrées
Développer des packages R

Vignettes vs articles

Vignette :

  • Cible des fonctionnalités propres au package
  • Fournit des exemples concrets
  • Généralement incluse dans la documentation du package

Article :

  • Traite de sujets ou recherches plus larges
  • Présente des résultats ou des idées
  • Publié séparément du package
Développer des packages R

Passons à la pratique !

Développer des packages R

Preparing Video For Download...