R package checklist

[gvegayon]

R Packages Checklist

Technical requirements

Our goal is for all R packages under EpiForeSITE to have the following features:

• Lives on GitHub.
• Has appropriate LICENSE file (see also licensing from R Packages (2e)).
• Documented with roxygen2 (Rd2roxygen converts .Rd files to roxygen2), including function descriptions, parameters and return values, details, examples, references, and links to other relevant functions.
• Includes at least one rmarkdown vignette with an extended example of package usage
• Has a website using pkgdown.
• Has tests using either tinytest or testthat.
• Uses continuous integration (CI) (e.g., GitHub Actions) to:
  • Run R CMD check on multiple system configurations.
  • Create the package website.

Additional requirements

• Is listed in EpiForeSITE/software repository.
• #11
• Has a badge pointing back to the EpiForeSITE/software.
• Has a badge indicating the package's readiness level.

Advanced Package Checklist

Once the above checklist is completed, there are some additional package features that would be nice to have but are not required:

• Published on CRAN (see CRAN's submission checklist).
• Uses pre-commit both as part of CI and for local development.
• Has a NEWS.md file.
• Has a Containerfile under .devcontainer.
• Uses GitHub's release system to keep the latest version current.
• Has branch protection rules that prevent direct commits to the principal branch (main or master).
• Uses codecov or coveralls to release code coverage (via the covr R package).

_{(Version 4d5bcbc)}