Vignette

gguyver · Jun 27, 2024 · fcf0173 · fcf0173
1 parent bb8c4a4
commit fcf0173
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@
 .httr-oauth
 .DS_Store
 .quarto
+inst/doc
diff --git 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
@@ -0,0 +1,2 @@
+*.html
+*.R
diff --git a/vignettes/animal-sounds.Rmd 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")
+```