R package checklist
- Check out (clone) the package repository as a RStudio project or create a R package project from RStudio menu File/New Project…;
- Test that the pakcage builds and loads without issue;
- Check the package with
devtools::check()
, which also runs tests inlcuded in the package; verify there are no errors or warnings;
- Does the package include tests? Do the tests run successfully?
- Verify that the package includes proper documents as roxygen comments in the R code files;
- (Does the package include vignettes?)
- Install the package and load it with
library
;
- See what functions are provided by the package with
ls("package:<package name>")
after loading it with library
;
- Study the vignettes and help documents to learn how to use it.
Class project tips
readxl
package reads data in excel files
- Use
equal_*
functions in the testthat package for tests
- Use
ggplot2
for visualization