Check Type — chk_class • chk

Checks inherits from class using

inherits(x, class)

Usage

chk_class(x, class, x_name = NULL)

vld_class(x, class)

Arguments

x: The object to check.
class: A character vector specifying the possible class values.
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_class(): Validate Inherits from Class

See also

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

Other id_checkers: chk_data(), chk_is(), chk_s3_class(), chk_s3_class_strict(), chk_s4_class()

Examples

# chk_class
chk_class(1, "numeric")
try(chk_class(getClass("MethodDefinition"), "classRepresentation"))
# vld_class
vld_class(numeric(0), "numeric")
#> [1] TRUE
vld_class(getClass("MethodDefinition"), "classRepresentation")
#> [1] TRUE