checkmate: qassertr – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

qassertr

Quick recursive arguments checks on lists and data frames

Description

These functions are the tuned counterparts of qtest, qassert and qexpect tailored for recursive checks of list elements or data frame columns.

Usage

qassertr(x, rules, .var.name = vname(x))

qtestr(x, rules, depth = 1L)

qexpectr(x, rules, info = NULL, label = vname(x))

Arguments

`x`	[`list` or `data.frame`] List or data frame to check for compliance with at least one of `rules`. See details of `qtest` for rule explanation.
`rules`	[`character`] Set of rules. See `qtest`
`.var.name`	[`character(1)`] Name of the checked object to print in error messages. Defaults to the heuristic implemented in `vname`.
`depth`	[`integer(1)`] Maximum recursion depth. Defaults to “1” to directly check list elements or data frame columns. Set to a higher value to check lists of lists of elements.
`info`	[character(1)] Extra information to be included in the message for the testthat reporter. See `expect_that`.
`label`	[`character(1)`] Name of the checked object to print in messages. Defaults to the heuristic implemented in `vname`.

Value

See qassert.

Examples

# All list elements are integers with length >= 1?
qtestr(as.list(1:10), "i+")

# All list elements (i.e. data frame columns) are numeric?
qtestr(iris, "n")

# All list elements are numeric, w/o NAs?
qtestr(list(a = 1:3, b = rnorm(1), c = letters), "N+")

# All list elements are numeric OR character
qtestr(list(a = 1:3, b = rnorm(1), c = letters), c("N+", "S+"))

checkmate

Fast and Versatile Argument Checks

v2.0.0

BSD_3_clause + file LICENSE

Authors

Michel Lang [cre, aut] (<https://orcid.org/0000-0001-9754-0393>), Bernd Bischl [ctb]

Initial release