Auto-generate VISCfunctions website with pkgdown/GH actions

.Rbuildignore

@@ -8,3 +8,6 @@ CONDUCT.md
 CONTRIBUTING.md
 ^\.github$
 data-raw/
+^_pkgdown\.yml$
+^docs$
+^pkgdown$

.github/workflows/pkgdown.yaml

@@ -0,0 +1,49 @@
+# 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:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown.yaml
+
+permissions: read-all
+
+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@v4
+
+      - 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/github-pages-deploy-action@v4.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -20,3 +20,4 @@ doc
 Meta
 /doc/
 /Meta/
+docs

DESCRIPTION

@@ -3,12 +3,16 @@ Package: VISCfunctions
 Title: VISC STP/SRA functions
 Version: 1.3.0.9000
 Authors@R: c(
-    person("Bryan", "Mayer", , "bmayer@fredhutch.org", role = "aut"),
-    person("Monica", "Gerber", , "mgerber@fredhutch.org", role = "aut"),
-    person("Celia", "Mahoney", , "cmahoney@fredhutch.org", role = "aut"),
-    person("Ellis", "Hughes", , "ehhughes@fredhutch.org", role = "aut"),
-    person("Heather", "Bouzek", , "hbouzek@fredhutch.org", role = "aut"),
-    person("Jimmy", "Fulp", , "wfulp@fredhutch.org", role = c("aut", "cre"))
+    person("Bryan", "Mayer", , "bmayer@fredhutch.org", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-2258-5276")),
+    person("Dave", "Slager", , "dslager@fredhutch.org", role = "aut", comment = c(ORCID = "0000-0003-2525-2039")),
+    person("Kellie", "MacPhee", , "kmacphee@fredhutch.org", role = "aut", comment = c(ORCID = "0009-0008-0993-4009")),
+    person("Gabrielle", "Lemire", , "glemire@fredhutch.org", role = "aut"),
+    person("Claudio", "Yurdadon", , "cyurdado@fredhutch.org", role = "aut", comment = c(ORCID = "0000-0002-4928-2737")),
+    person("Monica", "Gerber", , , role = "aut"),
+    person("Celia", "Mahoney", , , role = "aut"),
+    person("Ellis", "Hughes", , , role = "aut", comment = c(ORCID = "0000-0003-0637-4436")),
+    person("Heather", "Bouzek", , , role = "aut"),
+    person("Jimmy", "Fulp", , , role = "aut")
   )
 Description:
     Statistical, data processing, and annotation functions for VISC.
@@ -37,3 +41,4 @@ Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.3
+URL: https://fredhutch.github.io/VISCfunctions/

_pkgdown.yml

@@ -0,0 +1,4 @@
+url: https://fredhutch.github.io/VISCfunctions/
+template:
+  bootstrap: 5
+