nhs-r-community · ThomUK · Dec 12, 2023 · Dec 12, 2023 · Dec 12, 2023 · Dec 12, 2023
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -5,3 +5,7 @@
 ^CODE_OF_CONDUCT\.md$
 README.Rmd
 cran-comments.md
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
+^\.github$
diff --git a/.github/.gitignore b/.github/.gitignore
@@ -0,0 +1 @@
+*.html
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -0,0 +1,48 @@
+# 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]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/[email protected]
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs
diff --git a/.gitignore b/.gitignore
@@ -48,3 +48,4 @@ po/*~
 # RStudio Connect folder
 rsconnect/
 inst/doc
+docs
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -21,3 +21,4 @@ Suggests:
     knitr,
     rmarkdown
 VignetteBuilder: knitr
+URL: https://nhs-r-community.github.io/NHSRwaitinglist/
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,7 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
 export(average_wait)
-export(example_function)
 export(queue_load)
 export(relief_capacity)
 export(target_capacity)

diff --git a/R/example_function.R b/R/example_function.R
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -0,0 +1,4 @@
+url: https://nhs-r-community.github.io/NHSRwaitinglist/
+template:
+  bootstrap: 5
+
diff --git a/man/average_wait.Rd b/man/average_wait.Rd
diff --git a/man/example_function.Rd b/man/example_function.Rd
diff --git a/man/queue_load.Rd b/man/queue_load.Rd
diff --git a/man/relief_capacity.Rd b/man/relief_capacity.Rd
diff --git a/man/target_capacity.Rd b/man/target_capacity.Rd
diff --git a/man/target_queue_size.Rd b/man/target_queue_size.Rd
diff --git a/man/waiting_list_pressure.Rd b/man/waiting_list_pressure.Rd
diff --git a/vignettes/example_walkthrough.Rmd b/vignettes/example_walkthrough.Rmd
@@ -23,7 +23,7 @@ This vignette is a practical demonstration of the {NHSRwaitinglist} functions, u
 The example is centred on a P4 (priority 4) Ear, Nose & Throat (ENT) waiting list at an acute hospital.
 
 The package functions we will be using are:
-```{r child = 'functions_table.Rmd'}
+```{r child = 'functions_table.Md'}
 ```
 
 ## Setup
@@ -219,7 +219,7 @@ Closer attention should be paid to P2 procedures.
 
 This worked example aims to demonstrate the functions available in this package. 
 In chronological order of application they were:
-```{r child = 'functions_table.Rmd'}
+```{r child = 'functions_table.Md'}
 ```
 
 ## Further reading

diff --git a/vignettes/functions_table.Rmd → vignettes/functions_table.Md b/vignettes/functions_table.Rmd → vignettes/functions_table.Md