chk_is: Check Class

In chk: Check User-Supplied Function Arguments

Check Class

Description

Checks inherits from class using

inherits(x, class)

Usage

chk_is(x, class, x_name = NULL)

vld_is(x, class)

Arguments

x	The object to check.
class	A string specifying the class.
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_is(): Validate Inherits from Class

See Also

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

Examples

chk_is(1, "numeric")
try(chk_is(1L, "double"))

# vld_is
vld_is(numeric(0), "numeric")
vld_is(1L, "double")

chk documentation built on Oct. 6, 2023, 9:06 a.m.