chk_atomic: Check Atomic

In chk: Check User-Supplied Function Arguments

Check Atomic

Description

Checks if atomic using

is.atomic(x)

Usage

chk_atomic(x, x_name = NULL)

vld_atomic(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_atomic(): Validate Atomic

See Also

Other chk_is: chk_array(), chk_data(), chk_function(), chk_is(), chk_matrix(), chk_numeric(), chk_s3_class(), chk_s4_class(), chk_vector(), chk_whole_numeric()

Examples

# chk_atomic
chk_atomic(1)
try(chk_atomic(list(1)))
# vld_atomic
vld_atomic(1)
vld_atomic(matrix(1:3))
vld_atomic(character(0))
vld_atomic(list(1))
vld_atomic(NULL)

chk documentation built on Sept. 11, 2024, 7:34 p.m.