Add first vignette

LydiaYW · Nov 19, 2024 · 56d36f8 · 56d36f8
1 parent 984832d
commit 56d36f8
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 0 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -2,3 +2,6 @@
 ^\.Rproj\.user$
 ^\.github$
 ^README\.Rmd$
+^Rplots\.pdf$
+^doc$
+^Meta$
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,6 @@
 src/*.o
 src/*.so
 src/*.dll
+inst/doc
+/doc/
+/Meta/
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -17,5 +17,8 @@ Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.1
 Encoding: UTF-8
 Suggests: 
+    knitr,
+    rmarkdown,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
+VignetteBuilder: knitr
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
@@ -0,0 +1,2 @@
+*.html
+*.R
diff --git a/vignettes/FirstVignette.Rmd b/vignettes/FirstVignette.Rmd
@@ -0,0 +1,19 @@
+---
+title: "FirstVignette"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{FirstVignette}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup}
+library(egpkg)
+```