checkr (version 0.5.0)

check_classes: Check Classes

Description

Checks that an object inherits from one or more classes.

Usage

check_classes(x, classes = character(0), exclusive = FALSE,
  order = FALSE, x_name = substitute(x), error = TRUE)

Arguments

x

The object to check.

classes

A character vector of the classes x should inherit from.

exclusive

A flag indicating whether other classes are not permitted.

order

A flag indicating whether the object classes have to occur in the same order as classes.

x_name

A string of the name of the object.

error

A flag indicating whether to throw an informative error or immediately generate an informative message if the check fails.

Value

An invisible copy of x (if it doesn't throw an error).

Details

The classes of an object can be returned using the `class()` function.

See Also

check_inherits

Examples

# NOT RUN {
check_classes(list())
check_classes(list(), "list")
check_classes(list(), "numeric", error = FALSE)
# }