Progetta una vignetta per un pacchetto R
Questo documento è lo scheletro della vignetta dist_conversion.Rmd creato nell'ultimo esercizio. Include le parti più comuni di un documento R Markdown:
- Un'intestazione YAML che contiene alcuni metadati
- Testo discorsivo scritto in Markdown
- Blocchi di codice R racchiusi da
```{r}e```; una sintassi che proviene dal pacchettoknitr
Per sviluppare la documentazione del pacchetto unitConverter, è fondamentale mostrare agli utenti molti modi diversi di usare le funzionalità del pacchetto. Le vignette servono proprio a questo: mostrano esempi e aggiungono testo esplicativo e chiarimenti in un formato facile da leggere.
Questo esercizio fa parte del corso
Sviluppare pacchetti R
Istruzioni dell'esercizio
- Crea un'intestazione alla riga 22 con "Convert feet to meters" senza sottosezioni.
- Aggiungi "We can use the package to convert 5 feet into meters as follows." dopo l'intestazione, lasciando una riga vuota di spazio.
- Nel chunk dist-example, effettua la chiamata appropriata alla funzione
dist_converter()per svolgere l'attività che hai descritto. - Alla fine, mostra il risultato inline con "Five feet is
r dist_resultmeters."
Esercizio pratico interattivo
Prova a risolvere questo esercizio completando il codice di esempio.
{"dist_conversion.Rmd":"___\ntitle: \"Distance Conversion Examples\"\noutput: rmarkdown::html_vignette\nvignette: >\n %\\VignetteIndexEntry{Distance Conversion Examples}\n %\\VignetteEngine{knitr::rmarkdown}\n %\\VignetteEncoding{UTF-8}\n___\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n collapse = TRUE,\n comment = \"#>\"\n)\n```\n\n```{r setup}\nlibrary(unitConverter)\n```\n\n\n\n\n\n```{r dist-example}\ndist_result <- \n```\n\n\n"}