Added vignette template

saezlab · Jul 28, 2020 · 8b2274e · 8b2274e
1 parent 110ace2
commit 8b2274e
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -50,3 +50,4 @@ Icon
 
 docs
 docs/
+inst/doc
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -28,5 +28,8 @@ Imports:
 Suggests: 
     testthat,
     covr,
-    pkgdown
+    pkgdown,
+    knitr,
+    rmarkdown
 RoxygenNote: 7.1.1
+VignetteBuilder: knitr
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
@@ -0,0 +1,2 @@
+*.html
+*.R
diff --git a/vignettes/how-to.Rmd b/vignettes/how-to.Rmd
@@ -0,0 +1,19 @@
+---
+title: "How to decouple?"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{test}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup}
+library(decoupleR)
+```