📝 Adds demo vignette for data pipelines and outputs

.Rbuildignore

@@ -1,14 +1,16 @@
-^nhp_reskit[.]Rproj$
-^[.]Rproj[.]user$
-^LICENSE[.]md$
-^CODEOWNERS$
-^[.]github$
-^nhp_reskit[.]code-workspace$
-^CODEOWNERS$
-^[.]vscode$
-^air[.]toml$
-^[.]Renviron[.]example$
-^inst/a_.*$
-^test_results[.]rds$
-^[.]lintr$
-^jarl[.]toml$
+^nhp_reskit[.]Rproj$
+^[.]Rproj[.]user$
+^LICENSE[.]md$
+^CODEOWNERS$
+^[.]github$
+^nhp_reskit[.]code-workspace$
+^CODEOWNERS$
+^[.]vscode$
+^air[.]toml$
+^[.]Renviron[.]example$
+^inst/a_.*$
+^test_results[.]rds$
+^[.]lintr$
+^jarl[.]toml$
+^vignettes/\.quarto$
+^vignettes/*_files$

.gitignore

@@ -1,97 +1,99 @@
-# History files
-.Rhistory
-.Rapp.history
-
-# Session Data files
-.RData
-.RDataTmp
-
-# User-specific files
-.Ruserdata
-
-# Example code in package build process
-*-Ex.R
-
-# Output files from R CMD build
-/*.tar.gz
-
-# Output files from R CMD check
-/*.Rcheck/
-
-# RStudio files
-.Rproj.user/
-
-# produced vignettes
-vignettes/*.html
-vignettes/*.pdf
-
-# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
-.httr-oauth
-
-# knitr and R markdown default cache directories
-*_cache/
-/cache/
-
-# Temporary files created by R markdown
-*.utf8.md
-*.knit.md
-
-# Quarto rendered files and artefacts
-*.files/
-
-# R Environment Variables
-.Renviron
-
-# pkgdown site
-docs/
-
-# translation temp files
-po/*~
-
-# RStudio Connect folder
-rsconnect/
-
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-/.quarto/
-
-# VSCode extensions/settings
-/.vscode/
-
-inst/a_sort*
-!inst/a_sort*.qmd
-
-*.rds
+# History files
+.Rhistory
+.Rapp.history
+
+# Session Data files
+.RData
+.RDataTmp
+
+# User-specific files
+.Ruserdata
+
+# Example code in package build process
+*-Ex.R
+
+# Output files from R CMD build
+/*.tar.gz
+
+# Output files from R CMD check
+/*.Rcheck/
+
+# RStudio files
+.Rproj.user/
+
+# produced vignettes
+vignettes/*.html
+vignettes/*.pdf
+
+# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
+.httr-oauth
+
+# knitr and R markdown default cache directories
+*_cache/
+/cache/
+
+# Temporary files created by R markdown
+*.utf8.md
+*.knit.md
+
+# Quarto rendered files and artefacts
+*.files/
+
+# R Environment Variables
+.Renviron
+
+# pkgdown site
+docs/
+
+# translation temp files
+po/*~
+
+# RStudio Connect folder
+rsconnect/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+/.quarto/
+
+# VSCode extensions/settings
+/.vscode/
+
+inst/a_sort*
+!inst/a_sort*.qmd
+
+*.rds
+inst/doc
+**/.quarto/

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: reskit
 Title: Nice selection box of goodies for hobnobbing with NHP model results
-Version: 1.0.1
+Version: 1.1.0
 Authors@R:
     c(person(
         "Fran", "Barton",
@@ -27,7 +27,7 @@ Roxygen: list(markdown = TRUE)
 Config/testthat/edition: 3
 Depends: R (>= 4.5.0)
 Imports:
-    azkit (>= 0.3.0),
+    azkit (>= 0.3.1),
     base64enc,
     dplyr,
     forcats,
@@ -48,8 +48,11 @@ Remotes:
     The-Strategy-Unit/azkit
 Suggests:
     here,
+    knitr,
+    quarto,
     readr,
     testthat (>= 3.0.0),
     tibble,
     withr
 Config/roxygen2/version: 8.0.0
+VignetteBuilder: quarto

vignettes/.gitignore

@@ -0,0 +1,6 @@
+*.html
+*.R
+*_files
+
+/.quarto/
+**/*.quarto_ipynb

vignettes/nhp_reskit.qmd

@@ -0,0 +1,16 @@
+---
+title: "nhp_reskit"
+vignette: >
+  %\VignetteIndexEntry{nhp_reskit}
+  %\VignetteEngine{quarto::html}
+  %\VignetteEncoding{UTF-8}
+knitr:
+  opts_chunk:
+    collapse: true
+    comment: '#>'
+---
+
+```{r}
+#| label: setup
+library(reskit)
+```