Merge pull request #185 from nhs-r-community/add-spellchecker

Added spellchecker gh-action and files

.github/workflows/spellcheck.yml

@@ -0,0 +1,15 @@
+name: spellcheck
+
+on:
+  push:
+
+jobs:
+  spellcheck:
+    name: runner / spellcheck
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code.
+      uses: actions/checkout@v2
+    - name: Run PySpelling as a GitHub action
+      uses: sbates130272/[email protected]
+

.spellcheck.yaml

@@ -0,0 +1,20 @@
+matrix:
+- name: Markdown
+  aspell:
+    lang: en
+  dictionary:
+    wordlists:
+    - .wordlist.txt
+    output: wordlist.dic
+    encoding: utf-8
+  pipeline:
+  - pyspelling.filters.markdown:
+  - pyspelling.filters.html:
+      comments: false
+      ignores:
+      - code
+      - pre
+  sources:
+  - '**/*.qmd'
+  default_encoding: utf-8
+

.wordlist.txt

@@ -0,0 +1,155 @@
+actuallys
+AE
+anonymised
+aonymise
+anonymising
+anonymized
+ableist
+AphA
+Arial
+attractors
+Beeley
+beeley
+BFG
+callout
+Carpentries
+cc'ing
+chris
+Clipchamp
+CRAN
+CSU
+CVs
+Cyber
+cyber
+destdir
+de
+anonymising
+DM
+dt
+doxing
+eval
+Fosstodon
+Frutiger
+generalisable
+GDS
+ggplot2
+ggplot
+gh
+github
+GitHub
+gt
+HACA
+html
+http
+https
+ICB
+ICS
+Jahn
+Kirstie
+licenced
+lintr
+listserv
+MLCSU
+md
+mortem
+Netlify
+NHS
+nhs
+nhsr
+NHSD
+NHSR
+nhs-r
+NHS-R
+nhsrcommunity
+NHSRdatasets
+NHSRtheme
+nhsrway
+NHSRway
+nonconsensual
+OGL
+ok
+OK
+Ok
+pdf
+plotly
+png
+PNG
+pre
+pretix
+Pretix
+Prework
+programme
+Programme
+pycom
+quartostamp
+rcommunity
+README
+READMEs
+readme
+readmes
+Repo
+repo
+responders
+RMarkdown
+rOpenSci's
+rOpenSci
+RPySOC
+RPySoc
+RStudio
+rstudio
+sam
+SAS
+setwd
+sexualised
+smartsurvey
+SPSS
+socio
+SOPs
+SoundCloud
+Soundcloud
+SRCCON
+stringsAsFactors
+styler
+subcommunities
+sublicense
+submitters
+Substack
+svg
+Takedown
+Tamagotchi
+theming
+tidyverse
+tos
+usethis
+UDAL
+UK
+uk
+Unconference
+unconference
+upskilling
+url
+useR
+usethis
+vickers
+VPN
+VPNs
+Webaim
+workspaces
+workspace
+WorkingDir
+wikipedia
+Wikipedia
+www
+yml
+Zoë
+zoe
+cetera
+et
+exempli
+gratia
+exempli
+gratia
+nd
+st
+per
+se

code-of-conduct.qmd

@@ -251,7 +251,7 @@ In the event that sensitive information exists in forks/clones or is from anothe
 
 The majority of this Code of Conduct code is adapted from [The Turing Way Code of Conduct](https://github.com/alan-turing-institute/the-turing-way/blob/main/CODE_OF_CONDUCT.md) under the creative commons attribution license.
 
-Some parts have been added from the Code of Conduct that was originally list on the NHS-R Community website and had acknowledgements: [SRCCON](https://srccon.org/conduct/) This code of conduct was based on that developed for [useR! 2018](https://user2018.r-project.org/code_of_conduct/) which was a revision of the code of conduct used at previous useR!s and also drew from [rOpenSci’s code of conduct.](https://ropensci.org/coc/). 
+Some parts have been added from the Code of Conduct that was originally list on the NHS-R Community website and had acknowledgements: [SRCCON](https://srccon.org/conduct/) This code of conduct was based on that developed for [useR! 2018](https://user2018.r-project.org/code_of_conduct/) which was a revision of the code of conduct used at previous useR!s and also drew from [rOpenSci's code of conduct.](https://ropensci.org/coc/). 
 Exact text added can be found related to [issue 11](https://github.com/nhs-r-community/NHSR-way/issues/11) on the GitHub.
 
 We really appreciate the work that all of the communities that helped build The Turing Way, with credit particularly to Kirstie Whitaker. The Turing Way acknowledged many communities in their work and we also extend our appreciation to those groups and individuals (listed below). The ease of producing this comprehensive Code of Conduct is because of the acknowledged work being published under the [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) (CC BY 4.0 CA). This too is released under the same licence which means you are free to share and adapt the work so long as the attribution to and the NHS-R Community is retained, along with the attribution to The Turing Way, the Carpentries, the Alan Turing Institute Data Study Group organising team, Citizen Lab and the other resources.

community-handbook.qmd

@@ -150,7 +150,7 @@ We also allow Core membership for anyone who has retired and was in these servic
 
 Please contact [the core development team](#contact-us) for any of the following:
 
-To delete or change and account we can `Anonymize` your account where:
+To delete or change and account we can `Anonymise` your account where:
 
 >All orders will be disconnected from this customer account. The orders themselves will not be anonymized and can still contain personal information!
 The customer will no longer be able to log in and will lose access to any membership benefits.
@@ -218,7 +218,7 @@ The following questions were used for Coffee and Coding, `*`are next to mandator
   - plotly
   - Plotting but not using ggplot2 or plotly
   - Quarto
-  - Rmarkdown
+  - RMarkdown
   - Shiny
   - gt (tables)
   - dt tables
@@ -293,7 +293,7 @@ We have an accessibility statement on the [NHS-R Community website](https://nhsr
 It is likely that things will have been missed and we encourage comments, issues and suggestions for improvement.
 
 We have not currently assessed for compliant status as this is not something we can confidently assess ourselves.
-We have checked pages using the [Web Accesbility Evaluation Tool](https://wave.webaim.org/) to highlight areas for concern and improvement and acted upon many of its recommendations.
+We have checked pages using the [Web Accessibility Evaluation Tool](https://wave.webaim.org/) to highlight areas for concern and improvement and acted upon many of its recommendations.
 
 We collate useful Government, Public Sector and R based links related to accessibility in the [Open Analytics book](https://resources.nhsrcommunity.com/accessibility.html).
 

conference.qmd

@@ -58,11 +58,11 @@ We discuss assessing model quality and predictive accuracy. We then introduce th
 
 **Strategies to reduce cognitive load when coding** The volume of code produced as a project progresses can get overwhelming for the contributors. The talk will give a high level overview of the strategies that can be employed to make code more manageable. Inspired by the Targets package, the talk will discuss the benefits of a function based approach to writing code to improve readability and visibility of the workflow. The benefits of re-using functions, writing tests to ensure the functions are working as intended, and storing functions within a code library or package. The benefits of code reviews and strategies to implement these and how to use version control to support this process. The importance of user friendly documentation incorporating readme files, data dictionaries, flow diagrams and SOPs. The presentation will highlight strategies to reduce the cognitive load on code writers, reduce time debugging and make work easier to understand and handover to colleagues. The presentation will signpost to useful packages and resources to explore the topic further.
 
-**Did you hear? Base R is dead! Or is it?** I’ve spent most of my time in the public sector using the tidyverse, but I started learning R before the tidyverse existed (to be polite, you could call me ‘seasoned’). Recently I’ve started to write more base R code again. Why? I'll talk about how base R can do loads of neat stuff out of the box without you needing to install and update any packages (dependencies aren’t bad things per se, but can cause trouble if not managed appropriately). I'll also tell you about some recent additions, like the base pipe and lambda function notation, which demonstrate how base R is responding to the needs of the modern coder. Oh, and you can also do wacky stuff like make an interactive pixel-art creator, a persistent Tamagotchi pet, or a procedural dungeon-crawler. Note that this talk does not constitute a ‘base versus tidyverse' flamewar. It’s purely to appreciate the elegance of good ol’ base R and to highlight some things it can do that you might not have realised (or like me, you forgot a long time ago).
+**Did you hear? Base R is dead! Or is it?** I’ve spent most of my time in the public sector using the tidyverse, but I started learning R before the tidyverse existed (to be polite, you could call me ‘seasoned’). Recently I’ve started to write more base R code again. Why? I'll talk about how base R can do loads of neat stuff out of the box without you needing to install and update any packages (dependencies aren’t bad things per se, but can cause trouble if not managed appropriately). I'll also tell you about some recent additions, like the base pipe and lambda function notation, which demonstrate how base R is responding to the needs of the modern coder. Oh, and you can also do wacky stuff like make an interactive pixel-art creator, a persistent Tamagotchi pet, or a procedural dungeon-crawler. Note that this talk does not constitute a 'base versus tidyverse' flame war. It’s purely to appreciate the elegance of good old base R and to highlight some things it can do that you might not have realised (or like me, you forgot a long time ago).
 
 Full details are shared: <https://github.com/matt-dray/nhs-r-2023>
 
-### Abstract for a plenary plenary talk (20-30 mins)
+### Abstract for a plenary plenary talk (20-30 minutes)
 
 **You should blog with Quarto** One of the most sensible things I’ve done in my life is start an R blog. Not for clout or sponsorship deals (yet!), but so I can (1) write down what I’ve learnt about R and refer to it later, (2) help people who are looking for answers and (3) improve my communication skills. Why don’t you join the blogger lifestyle too? Or maybe you already blog, but you want to do it more often and on a platform that you’ll actually enjoy using. I’ll walk you through the process of setting up a blog using Quarto, the most hip publishing framework around. That’s right, you can use R to set up your blog and write posts about R. I’ll talk about how to deploy it for free and automatically with Netlify and also how you can hook it up with that domain name you bought years ago but never got around to using. As a bonus, I’ll give you some prompts for what to write about and some insider info on what’s been the most successful and most rewarding content for me in over 150 posts to date.
 

style-guides.qmd

@@ -99,7 +99,7 @@ Write external links using "http://" instead of "www". This ensures they are cor
 ## Chunks with code or special text
 
 You can ensure that any code (or Markdown) chunks you have in the guide have the code syntax highlighted by mentioning the language in question.
-As an example, if you want to have some R code, when you open the chunk with three backticks you can add the language name immediately after it (<code>\`\`\`</code> becomes <code>\`\`\`R</code>).
+As an example, if you want to have some R code, when you open the chunk with three back ticks you can add the language name immediately after it (<code>\`\`\`</code> becomes <code>\`\`\`R</code>).
 
 Markdown source:
 
@@ -178,7 +178,7 @@ The case will also match the original package and function.
 
 ## Logo
 
-The logo incorporates the [R logo](https://commons.wikimedia.org/wiki/File:R_logo.svg) available under the Creative Commons Atrribution-Share Alike 4.0 International licence and is available in png and svg formats through the [assets repository](https://github.com/nhs-r-community/assets/tree/main/logo).
+The logo incorporates the [R logo](https://commons.wikimedia.org/wiki/File:R_logo.svg) available under the Creative Commons Attribution-Share Alike 4.0 International licence and is available in png and svg formats through the [assets repository](https://github.com/nhs-r-community/assets/tree/main/logo).
 
 The NHS-R logo has been in use since 2018.
 
@@ -218,7 +218,7 @@ As standard all NHS-R GitHub repository READMEs should include the following tex
 ```
 # Installation 
 
-You can install the current version of {name of pacakge} from GitHub with:
+You can install the current version of {name of package} from GitHub with:
 ```
 ```{r}
 #| eval: false