Check Scalar — chk_scalar • chk

Checks if is a vector using

length(x) == 1L

Usage

chk_scalar(x, x_name = NULL)

vld_scalar(x)

Arguments

x: The object to check.
x_name: A string of the name of object x or NULL.

Value

The chk_ function throws an informative error if the test fails or returns the original object if successful so it can used in pipes.

The vld_ function returns a flag indicating whether the test was met.

Functions

vld_scalar(): Validate Scalar

See also

For more details about the use of this function, please read the article vignette("chk-families").

Other scalar_checkers: chk_count(), chk_date(), chk_date_time(), chk_false(), chk_flag(), chk_lgl(), chk_string(), chk_true(), chk_tz()

Examples

# chk_scalar
chk_scalar(1)
chk_scalar(list(1))
try(chk_scalar(1:2))
#> Error in eval(expr, envir) : `1:2` must be a scalar (length 1).
# vld_scalar
vld_scalar(1)
#> [1] TRUE