Checklist for creating an R package

I started writing R packages in early 2017. For a while I found the initial set up for a new package involved more guess-work than I’d like (e.g. start from GitHub first or RStudio? When do you normally add a license?). Here’s my personal checklist for getting a minimal R package started in a consistent way:

1. Create an empty GitHub repo (with a license)
2. Create a new project in RStudio (tick the box to create a git repo)
3. git rm the default hello world function
4. Add a git remote
5. Cache git credentials
6. Add username and email to git
7. stage, commit, and push (may need a personal access token if GitHub is set up with 2FA)

This checklist reflects how I currently work. So it’ll most likely change as my workflow evolves.

Bonus Checklist

Some extras to make life easier for others (including future self):

• Update the DESCRIPTION file
• Add some basic documention:
  • Create a README with usethis::use_readme_rmd()
  • Add a status badge
  • Add a URL to the GitHub repo webpage
• Maybe set up CI and a pkgdown site for larger projects

This book is an excellent resource for taking best practice further: rOpenSci Packages: Development, Maintenance, and Peer Review.