add vignette template

aberHRML · Sep 23, 2020 · f3159da · f3159da
1 parent c7c2f89
commit f3159da
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@
 .RData
 .Ruserdata
 cran_submission
+inst/doc
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -22,5 +22,8 @@ RoxygenNote: 7.1.0
 Suggests: 
     covr,
     testthat,
-    tibble
+    tibble,
+    knitr,
+    rmarkdown
 Roxygen: list(markdown = TRUE)
+VignetteBuilder: knitr
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
@@ -0,0 +1,2 @@
+*.html
+*.R
diff --git a/vignettes/Introduction_to_metabolighteR.Rmd b/vignettes/Introduction_to_metabolighteR.Rmd
@@ -0,0 +1,19 @@
+---
+title: "Introduction_to_metabolighteR"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Introduction_to_metabolighteR}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup}
+library(metabolighteR)
+```