Progettare le vignette dei pacchetti R

Sviluppare pacchetti R

Jasmin Ludolf

Content Developer

Crea lo scheletro della vignette

library(usethis)

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

name:

  • Nome file per la nuova vignette
  • Solo numeri, lettere, underscore e trattini
  • Minuscolo consigliato

 

title: Va dentro la vignette

Sviluppare pacchetti R

Output di use_vignette()

output di use_vignette()

Sviluppare pacchetti R

Output di use_vignette()

output di use_vignette()

Sviluppare pacchetti R

Output di use_vignette()

output di use_vignette()

Sviluppare pacchetti R

Output di use_vignette()

output di use_vignette()

Sviluppare pacchetti R

Output di use_vignette()

output di use_vignette()

Sviluppare pacchetti R

Output di use_vignette()

output di use_vignette()

Sviluppare pacchetti R

Scheletro della vignette nel file func_conversion.Rmd

Scheletro della vignette

Sviluppare pacchetti R

Scheletro della vignette nel file func_conversion.Rmd

Scheletro della vignette

Sviluppare pacchetti R

Scheletro della vignette nel file func_conversion.Rmd

Scheletro della vignette

Sviluppare pacchetti R

Scheletro della vignette nel file func_conversion.Rmd

Scheletro della vignette

Sviluppare pacchetti R

Ripasso: buone pratiche per le vignette

  • Contenuti chiari e mirati
  • Struttura ben organizzata
  • Esempi e casi d’uso coinvolgenti
Sviluppare pacchetti R

Aggiorna la vignette seguendo le buone pratiche

Aggiorna la vignette

Sviluppare pacchetti R

Aggiorna la vignette seguendo le buone pratiche

Aggiorna la vignette

Sviluppare pacchetti R

Aggiorna la vignette seguendo le buone pratiche

Aggiorna la vignette

Sviluppare pacchetti R

Aggiorna la vignette seguendo le buone pratiche

Aggiorna la vignette

Sviluppare pacchetti R

Aggiorna la vignette seguendo le buone pratiche

Aggiorna la vignette

Sviluppare pacchetti R

Due modi per creare le vignette

  • rmarkdown::render()

    • Utile per testare sintassi ed esempi in sviluppo
    • Su DataCamp, usa il pulsante Knit HTML
  • devtools::build_vignettes()

    • Aggiunge formalmente (tutte le vignette) al pacchetto
    • Crea anche un file .R con tutto il codice R della vignette
    • Mette HTML, .R e .Rmd risultanti nella cartella doc
Sviluppare pacchetti R

Passons à la pratique !

Sviluppare pacchetti R

Preparing Video For Download...