Conventions in xportr

xportr strives to follow the guidance laid out in the R Packages manual.

We do deviate in the following ways:

• Double colon usage ::
  • Avoid the use of :: in our code and use a xportr-package.R file to load all the needed imports
  • Exception in Suggested packages that need to use double colon to avoid errors in R CMD check

Assertions

All public functions should check their arguments using the {checkmate} package. Please use snake case functions (assert_integer instead of assertInteger).

new_public_function <- function(a_string) {
  assert_string(a_string, min.chars = 1L)
  # ...
}