resources

This wiki page provides a collection of links to resources considered to be useful in the context of writing API clients in R the way we did.

The list is created dynamically and has no claim to completeness (and consequently the failure to mention sources is in no way due to bad will). Additions are most welcome 🙏 🙂

Useful for general introduction and concepts are:

• R packages book: provides a good introduction and overview.
• ropensci package guide: could be really useful to check out for best practices.
• rhub blog: contains more technical/advanced blog posts about R package development

APIs, data standards, and structures

• XLSForm: "a standard to help simplify the authoring of forms in Excel."

CI/CD & GitHub Actions

• GitHub Actions Tutorial - Basic Concepts and CI/CD Pipeline with Docker by Nana Janashia

Git

• Git branching workflows: https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows
• A gist on branching: https://gist.github.com/digitaljhelms/4287848
• Blogpost on git branch naming conventions: https://deepsource.io/blog/git-branch-naming-conventions/
• Another blogpost on git branch naming conventions / best practices: https://codingsight.com/git-branching-naming-convention-best-practices/

OOP (general / with R6)

OOP design patterns, etc

• Beyond design patterns and principles by Matthias Noback. Here are the slides. It's a PHP conference, but the content is agnostic to the language (to some extent).
• The R6 Class System by Winston Chang, useR 2017 🎥
• The Unified modelling language (UML)

The R6 package

• Chapter on R6 in Advanced R
• Package vignette on documenting R6 classes
• Example package: stan-dev/cmdstanr
• Active bindings, a blogpost by Colin Fay
• Active bindings, a blogpost by Collin Erickson

Testing

Unit testing

• Introductory chapter in R Packages book
• Introductory blogpost by Karl Broman
• testthat 📦
• mockery 📦, see also the vignette
• autotest 📦

Http testing

• HTTP testing book by ROpenSci
• vcr 📦

---

Other intersting R packages

Argument checking in R functions

• assertr 📦
• assertthat 📦
• checkmate 📦