assert: Assertions

In bigassertr: Assertion and Message Functions

Assertions

Description

• assert_nona(): checks that there is no missing value.

• assert_args(): checks that f is a function and that it has arguments called args.name.

• assert_lengths(): checks that objects have the same length.

• assert_one_bool(): checks whether either TRUE or FALSE.

• assert_one_int(): checks that object is integer-ish of length 1.

• assert_int(): checks that values are integer-ish (or NULL).

• assert_pos(): checks that values are (strictly) positive.

• assert_01(): checks that values are either 0 or 1.

• assert_multiple(): checks that there are multiple unique values. Errors if there are one unique values (or none). Warns if there are two unique values only.

• assert_class(): checks that object is of a particular class.

• assert_class_or_null(): checks that object is of a particular class (or NULL).

• assert_all(): checks that all values of an object are the same as value. Default checks that values are all TRUE. This function tests equality; beware precision errors (e.g. (0.1 + 0.2) != 0.3).

• assert_dir(): checks that directory exists, or tries to create it.

• assert_exist(): checks that file exists.

• assert_noexist(): checks that file does not exist.

• assert_nodots(): checks that ... are not used in a function.

• assert_ext(): checks that file has a particular extension.

• assert_type(): checks that values are of a particular type.

• assert_sorted(): checks that values are sorted.

• assert_package(): checks that a package is installed.

• assert_df_with_names(): checks that it is a data frame with some required variables names. There can be additional variables as well.

Usage

assert_nona(x)

assert_args(f, args.name)

assert_lengths(...)

assert_int(x)

assert_one_int(x)

assert_one_bool(x)

assert_pos(x, strict = TRUE)

assert_01(x)

assert_multiple(x)

assert_class(x, class)

assert_class_or_null(x, class)

assert_all(x, value = TRUE)

assert_dir(dir.path)

assert_exist(file)

assert_noexist(file)

assert_nodots()

assert_ext(file, ext)

assert_type(x, type)

assert_sorted(x, strict = FALSE)

assert_package(pkg)

assert_df_with_names(df, names)

Arguments

x	Usually a vector.
f	A function.
args.name	Vector of (argument) names to check.
...	Objects to check.
strict	Whether to check for strict positivity? Default is TRUE.
class	Class to check.
value	Value to check.
dir.path	Directory to check.
file	File to check.
ext	Extension to check (without the dot at the beginning).
type	Type to check.
pkg	Name of a package.
df	A data frame.
names	Variable names to check.

Examples

assert_nona(1:3)
assert_args(assert_nona, "x")
assert_lengths(1:3, 4:6, as.list(1:3))
assert_int(c(1, 2, 3))
assert_01(c(0, 1, 0))
assert_multiple(1:3)
assert_class(assert_nona, "function")
assert_all(1:3 > 0)
assert_all(rep(0, 3), 0)
assert_dir(tempdir())
assert_noexist(tmp <- tempfile())
write("test", tmp)
assert_exist(tmp)
assert_ext("test.txt", "txt")
assert_type(1:3, "integer")
assert_sorted(1:3)
assert_package("stats")
assert_df_with_names(iris, c("Sepal.Length", "Sepal.Width"))

test <- function(...) {
  assert_nodots()
  NULL
}
test()

bigassertr documentation built on Jan. 10, 2023, 5:13 p.m.