6 Create R Package

6.1 Readings

6.3 R package checklist

  1. Check out (clone) the package repository as a RStudio project or create a R package project from RStudio menu File/New Project…;
  2. Test that the pakcage builds and loads without issue;
  3. Check the package with devtools::check(), which also runs tests inlcuded in the package; verify there are no errors or warnings;
  4. Does the package include tests? Do the tests run successfully?
  5. Verify that the package includes proper documents as roxygen comments in the R code files;
  6. (Does the package include vignettes?)
  7. Install the package and load it with library;
  8. See what functions are provided by the package with ls("package:<package name>") after loading it with library;
  9. Study the vignettes and help documents to learn how to use it.

6.4 Exercise

Re-organize the function(s) you developed in the R coding basics section into a R package:

  • Use roxgen comments to specify the dependencies of your function(s);
  • Use roxgen comments to document your function(s);
  • [Advanced] Create tests for your functions;
  • Make sure your package build and load properly;
  • Go through the R package checklist;
  • Commit your package as a GitHub repository.