Skip to content

Conventions in xportr

André Veríssimo edited this page Dec 8, 2023 · 5 revisions

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

We do deviate in the following ways:

  • We try and avoid the use of :: in our code and use a xportr-package.R file to load all the needed imports.

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)
  # ...
}
Clone this wiki locally