chk_s3_class: Check Type

In chk: Check User-Supplied Function Arguments

Check Type

Description

Checks inherits from S3 class using

!isS4(x) && inherits(x, class)

Usage

chk_s3_class(x, class, x_name = NULL)

vld_s3_class(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_s3_class(): Validate Inherits from S3 Class

See Also

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

Examples

# chk_s3_class
chk_s3_class(1, "numeric")
try(chk_s3_class(getClass("MethodDefinition"), "classRepresentation"))
# vld_s3_class
vld_s3_class(numeric(0), "numeric")
vld_s3_class(getClass("MethodDefinition"), "classRepresentation")

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