From b1453d7302752566a9e6982ebee00835f2f3c69a Mon Sep 17 00:00:00 2001
From: Douglas Ezra Morrison <demorrison@ucdavis.edu>
Date: Thu, 12 Dec 2024 15:09:09 -0800
Subject: [PATCH] spellcheck

---
 .github/workflows/check-spelling.yaml | 23 +++++++++++++++++++++++
 DESCRIPTION                           |  4 +++-
 inst/WORDLIST                         | 15 +++++++++++++++
 tests/spelling.R                      |  3 +++
 4 files changed, 44 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/check-spelling.yaml
 create mode 100644 inst/WORDLIST
 create mode 100644 tests/spelling.R

diff --git a/.github/workflows/check-spelling.yaml b/.github/workflows/check-spelling.yaml
new file mode 100644
index 0000000..746aba5
--- /dev/null
+++ b/.github/workflows/check-spelling.yaml
@@ -0,0 +1,23 @@
+---
+name: Spellcheck
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    name: Spellcheck
+    container:
+      image: rocker/tidyverse:4.1.2
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Run Spelling Check test
+        uses: insightsengineering/r-spellcheck-action@v3.0.2
diff --git a/DESCRIPTION b/DESCRIPTION
index 8fac631..31bf2f8 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -46,7 +46,9 @@ Suggests:
     parameters,
     plotly,
     survminer,
-    tidyr
+    tidyr,
+    spelling
 RoxygenNote: 7.3.2
 License: MIT + file LICENSE
 Config/build/copy-method: link
+Language: en-US
diff --git a/inst/WORDLIST b/inst/WORDLIST
new file mode 100644
index 0000000..487452e
--- /dev/null
+++ b/inst/WORDLIST
@@ -0,0 +1,15 @@
+Biostat
+Epi
+Github
+Hua
+MathJax
+NoDerivatives
+NonCommercial
+ORCID
+Rocke
+UC
+Zhou
+demstats
+github
+iteratively
+qmd
diff --git a/tests/spelling.R b/tests/spelling.R
new file mode 100644
index 0000000..6713838
--- /dev/null
+++ b/tests/spelling.R
@@ -0,0 +1,3 @@
+if(requireNamespace('spelling', quietly = TRUE))
+  spelling::spell_check_test(vignettes = TRUE, error = FALSE,
+                             skip_on_cran = TRUE)