check_inherits: Check Inherits

View source: R/inherits.R

check_inheritsR Documentation

Check Inherits

Description

Checks if an object inherits from a class.

Usage

check_inherits(x, class, x_name = substitute(x), error = TRUE)

Arguments

x

The object to check.

class

A string of the class x should inherit from.

x_name

A string of the name of the object x.

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).

See Also

check_classes

Examples

check_inherits(list(), "list")
check_inherits(list(), "numeric", error = FALSE)

poissonconsulting/checkr documentation built on Oct. 18, 2023, 9:39 p.m.