Using pkgtemplate

Source: vignettes/pkgtemplate.Rmd

In order to create a new package the user should

  1. Go to the pkgtemplate GitHub repository and choose ‘Use this template’.
  2. Clone the new repository and replace ‘pkgtemplate’ with the name of the new package in DESCRIPTION, NEWS.md, tests/testthat.R, vignettes/pkgtemplate.Rmd and this README.Rmd file.
  3. devtools::check() the package and fix any Errors, Warnings or Notes.
  4. Knit this README.Rmd file and pkgdown::build_site().
  5. Add the project to Travis and in the Settings add a Cron Job to run the master branch daily if there hasn’t been a build in the last 24h.
  6. Add the project to Appveyor.
  7. Rename the pkgtemplate.Rproj and vignettes/pkgtemplate.Rmd files.
  8. Push the changes to the new repository.
  9. Go to the repository GitHub settings and set the GitHub Pages Source to be the master branch /docs folder.
  10. Edit the GitHub repository description and set the website to be https://poissonconsulting.github.io/pkgtemplate/.
  11. If you aren’t developing a Shiny app, run pkgtemplate:::cannibalise_shiny(getwd()) to remove any Shiny-related files (make sure that getwd() points to the correct place!)