template

Set-up

This is a template repository for NHS-R packages. It set’s up a number of things ready to start developing R-packages.

After creating a new repository from this template make sure to update:

• Update the title and installation section in Readme.Rmd
• Remove the Set-up section in Readme.Rmd
• Update the DESCRIPTION file as relevant
• Update the universe repository, so your package is included in nhs-r-community.r-universe.dev

Actions

This template set’s up the following actions on all PR’s and pushes to the main branch:

• R-CMD check to check your package is valid, passes tests etc.
• {lintr} to run static code analysis, will annotate your commits with any issues discovered.
• {covr} to run code coverage and upload to codecov.io.
• {pkgdown} to deploy package documentation to GitHub pages.

These actions will ensure that your package is building correctly, passing tests, and will help you stick to the tidyverse style guide.

Installation

You can install the released version of template from GitHub with:

install.packages("remotes")
remotes::install_github("nhs-r-community/[YOUR_REPOSITORY])

Development

As this is using a Readme.Rmd file to generate the Readme.md file you should enable the git hooks to prevent occidentally checking in Readme.Rmd without updating Readme.md. Make sure to run usethis::use_readme_rmd() after you checkout this repository.