Introduzione alle vignette dei pacchetti R

Sviluppare pacchetti R

Jasmin Ludolf

Content Developer

Struttura di un pacchetto R

Scopo delle vignette nella documentazione dei pacchetti R

• Spiegazioni dettagliate
• Esempi pratici
• Tutorial completi

Best practice per le vignette

• Contenuti chiari e mirati
• Struttura ben organizzata
  • Titoli e sottotitoli chiari
  • Testo che anticipa il codice R
  • Codice R semplice
  • Testo che discute i risultati
• Esempi e casi d'uso coinvolgenti

Esplorare una vignetta di un pacchetto R

• Trova esempi di best practice nelle vignette di altri pacchetti

browseVignettes("dplyr")

Esplorare una vignetta di un pacchetto R

• Trova esempi di best practice nelle vignette di altri pacchetti

browseVignettes("dplyr")

Versione HTML di una vignetta

Versione sorgente di una vignetta

Versione sorgente di una vignetta

Header YAML della versione sorgente della vignetta

 

Metadati della vignetta

• Titolo (title:) - riassume il contenuto
• Output (output:) - tipo di output, di solito rmarkdown::html_vignette
• Descrizione (description: >) - panoramica del contenuto
• Vignette (vignette: >) - metadati aggiuntivi, usa %\ per iniziare le voci

Vignette vs articoli

Vignetta:

• Si concentra sulle funzionalità del pacchetto
• Fornisce esempi pratici
• Di solito inclusa nella documentazione del pacchetto

Articolo:

• Copre temi o ricerche più ampie
• Presenta risultati o approfondimenti
• Pubblicato separatamente dal pacchetto

Passiamo alla pratica !

Sviluppare pacchetti R