diff --git a/.gitignore b/.gitignore index 7c794aa..72e042c 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ .httr-oauth .DS_Store .quarto +inst/doc diff --git a/DESCRIPTION b/DESCRIPTION index 820ff23..6af78ea 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -15,8 +15,11 @@ Imports: rlang, cli Suggests: + knitr, + rmarkdown, testthat (>= 3.0.0) Config/testthat/edition: 3 Depends: R (>= 2.10) LazyData: true +VignetteBuilder: knitr diff --git a/vignettes/.gitignore b/vignettes/.gitignore new file mode 100644 index 0000000..097b241 --- /dev/null +++ b/vignettes/.gitignore @@ -0,0 +1,2 @@ +*.html +*.R diff --git a/vignettes/animal-sounds.Rmd b/vignettes/animal-sounds.Rmd new file mode 100644 index 0000000..637d2ae --- /dev/null +++ b/vignettes/animal-sounds.Rmd @@ -0,0 +1,20 @@ +--- +title: "animalsoundr Getting Started" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{animalsoundr Getting Started} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} +--- + +```{r, include = FALSE} +knitr::opts_chunk$set( + collapse = TRUE, + comment = "#>" +) +``` + +```{r setup} +library(animalsoundr) +animal_sounds("dog", "woof") +```