added vignette of literature results as rmd

MFaymon · Mar 19, 2024 · ce15355 · ce15355
1 parent 7ee951a
commit ce15355
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -48,3 +48,4 @@ unnamed-chunk-*.pdf
 *fdb_latexmk
 
 .DS_Store
+inst/doc
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -47,3 +47,4 @@ Suggests:
     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/Replicate_literature_results_using_spINAR.Rmd b/vignettes/Replicate_literature_results_using_spINAR.Rmd
@@ -1,3 +1,23 @@
+---
+title: "Replication of results from the literature using the spINAR package"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Replication of results from the literature using the spINAR package}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup}
+library(spINAR)
+```
+
 # Application
 
 This file provides reproduced results from the literature for each provided functionality of the \textit{spINAR} package.