Create / update vignette(s)

.Rbuildignore

@@ -11,3 +11,8 @@
 ^[.]?air[.]toml$
 ^\.vscode$
 ^data-raw$
+^vignettes/\.quarto$
+^vignettes/*_files$
+^vignettes/articles/\.quarto$
+^vignettes/articles/*_files$
+^vignettes/articles$

.github/workflows/pkgdown.yaml

@@ -1,16 +1,16 @@
 # Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
 on:
-  push:
-    branches: [main, master]
   pull_request:
-    branches: [main, master]
+    branches: main
   release:
     types: [published]
   workflow_dispatch:
 
 name: pkgdown
 
+permissions: read-all
+
 jobs:
   pkgdown:
     runs-on: ubuntu-latest
@@ -22,7 +22,7 @@ jobs:
     permissions:
       contents: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: r-lib/actions/setup-pandoc@v2
 
@@ -41,7 +41,7 @@ jobs:
 
       - name: Deploy to GitHub pages 🚀
         if: github.event_name != 'pull_request'
-        uses: JamesIves/github-pages-deploy-action@v4.4.1
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
         with:
           clean: false
           branch: gh-pages

.gitignore

@@ -7,3 +7,4 @@
 inst/doc
 docs
 LICENSE
+**/.quarto/

DESCRIPTION

@@ -4,43 +4,51 @@ Version: 0.0.9
 Authors@R:
     c(
         person(
-            "Zoë", "Turner", , "zoe.turner3@nhs.net", c("cre", "aut"),
-            comment = c(ORCID = "0000-0003-1033-9158")
+            "Fran", "Barton", email = "francis.barton@nhs.net",
+            role = c("cre", "aut"),
+            comment = c(ORCID = "0000-0002-5650-1176")
         ),
         person(
-            "Fran", "Barton", , "francis.barton@nhs.net", "aut",
-            comment = c(ORCID = "0000-0002-5650-1176")
+            "Zoë", "Turner", email = "zoe.turner3@nhs.net",
+            role = "aut",
+            comment = c(ORCID = "0000-0003-1033-9158")
         ),
         person(
-            "NHS-R community", email = "nhs.rcommunity@nhs.net", role = "cph"
+            "NHS-R Community", email = "nhs.rcommunity@nhs.net", role = "cph"
         )
     )
-Maintainer: Zoë Turner <zoe.turner3@nhs.net>
-Description: Extracts data from the postcodes.io API for collections of UK
-    postcodes, such as their LSOA (or equivalent), parliamentary constituency,
-    and spatial coordinates. It can also check postcodes for currency/validity
-    and suggest replacement current postcodes for terminated codes.
+Maintainer: Fran Barton <francis.barton@nhs.net>
+Description: The main purpose of the package is to extract data from the
+    postcodes.io API for collections of UK postcodes, such as their LSOA (or
+    equivalent), parliamentary constituency, and spatial coordinates. It can
+    also check postcodes for currency/validity and suggest replacement current
+    postcodes for terminated codes.
 License: MIT + file LICENCE
 Encoding: UTF-8
 RoxygenNote: 7.3.2
 Roxygen: list(markdown = TRUE)
+LazyData: true
+VignetteBuilder: quarto
+Config/Needs/website: quarto
 Config/testthat/edition: 3
-VignetteBuilder: knitr
 Depends:
     R (>= 4.4.0)
 Imports:
     assertthat,
     cli,
     dplyr (>= 1.1.0),
+    glue,
     httr2 (>= 1.0.0),
     purrr (>= 1.0.0),
     rlang,
     tibble,
     tidyr,
     utils
 Suggests:
+    knitr,
+    quarto,
+    rvest,
     testthat (>= 3.0.0)
 URL: https://nhs-r-community.github.io/NHSRpostcodetools/,
     https://github.com/nhs-r-community/NHSRpostcodetools
 BugReports: https://github.com/nhs-r-community/NHSRpostcodetools/issues
-LazyData: true

_pkgdown.yml

@@ -1,19 +1,11 @@
 url: https://nhs-r-community.github.io/NHSRpostcodetools/
 template:
   bootstrap: 5
+  bootswatch: sandstone
+  light-switch: true
+  theme: ayu-light
+  theme-dark: ayu-dark
 navbar:
   structure:
-    left:
-    - intro
-    - articles
-    - news
-    right:
-    - search
-    - reference
-    - github
-
-authors:
-  footer:
-    roles: [aut]
-  sidebar:
-    roles: [aut]
+    left:  [intro, reference, articles, news]
+    right: [search, github, lightswitch]

vignettes/.gitignore

@@ -1,2 +1,3 @@
 *.html
 *.R
+*_files

vignettes/articles/.gitignore

@@ -0,0 +1,3 @@
+*.html
+*.R
+*_files

vignettes/filtering.qmd

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

vignettes/fixing.qmd

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