Update test and vignette infra

Author: pratikunterwegs

README.Rmd

@@ -1,6 +1,8 @@
 ---
 output: github_document
-# add bibliography here
+# NOTE: place references if any as a JSON in `vignettes/resources`
+# NOTE: references file can have any name, and there can be separate references per vignette
+bibliography: vignettes/resources/references.json
 link-citations: true
 ---
 
@@ -33,9 +35,7 @@ Replace all instances of `"vimc.rpkg.template"` with your package name. Make sur
 
 2. Edit the files in `R/`, `tests/`, and `vignettes/` to suit your package;
 
-3. Add spell check by running `usethis::use_spell_check(lang = "en-GB")`;
-
-4. Remove these instructions from `README.Rmd`, and re-render the `.md` file using `devtools::render_readme()`.
+3. Remove these instructions from `README.Rmd`. Then, either let the automated GitHub Actions workflow update `README.md` once the change is pushed to GitHub, or disable the workflow by removing the file `.github/workflows/render-readme.yaml`, and manually re-render the `.md` file using `devtools::render_readme()`.
 
 ## Installation
 
@@ -71,6 +71,8 @@ If preparatory or plotting steps are needed, prefer to hide them to keep focus o
 
 Add information and links to related projects, such as research papers or packages, here.
 
+An example citation would be @echeverria-londono2021.
+
 ## References
 
-Space for references: REMOVE this text.
+**Space for references: REMOVE this sub-section if there are no references. References, if any, should appear below this text. Remove this text in packages.**

tests/spelling.R

@@ -1,7 +1,6 @@
-if (requireNamespace("spelling", quietly = TRUE)) {
+if (requireNamespace('spelling', quietly = TRUE))
   spelling::spell_check_test(
     vignettes = TRUE,
     error = FALSE,
     skip_on_cran = TRUE
   )
-}

tests/testthat/helper-state.R

@@ -5,15 +5,6 @@
 # function, or more conveniently with the `withr` package.
 # We add a test on R >= 4.0.0 because some functions such as
 # `globalCallingHandlers()` did not exist before.
-get_pars_toreset <- function() {
-  pars <- par(no.readonly = TRUE)
-  # The following params are set and modified automatically by plot(), as
-  # documented in ?plot.window() and we:
-  # 1. have no control over them
-  # 2. do not care about resetting them
-  pars <- pars[!names(pars) %in% c("usr", "xaxp", "yaxp")]
-}
-
 if (getRversion() >= "4.0.0") {
   testthat::set_state_inspector(function() {
     list(

vignettes/vimc-rpkg-template.Rmd

@@ -1,6 +1,9 @@
 ---
 title: "vimc-rpkg-template"
 output: rmarkdown::html_vignette
+# NOTE: make references if any available as a JSON at a location, see e.g. below
+# NOTE: uncomment the line below, and update the references path as needed
+# bibliography: resources/references.json
 vignette: >
   %\VignetteIndexEntry{vimc-rpkg-template}
   %\VignetteEngine{knitr::rmarkdown}