validate: Validate an S4 class

In steinbaugh/goalie: Assertive Check Functions

Validate an S4 class

Description

validate() is a variant of assert() that is specifically intended to be used inside of an S4 validity method definition.

Usage

validate(..., msg = NULL)

Arguments

...	Any number of R expressions that return logical(1), each of which should evaluate to TRUE. Rather than combining expressions with &&, separate them by commas so that better error messages can be generated.
msg	NULL or character(1). Custom message to return.

Details

Like assert(), validate() returns TRUE on success. However, on failure it returns a character instead of a stop() call. This is the current recommended practice for defining S4 validity methods inside of a setValidity() call. Refer to the documentation in the methods package, specifically validObject() for detailed information on S4 validity methods.

Value

TRUE on success, or character(1) on failure, containing an error message.

Note

Updated 2021-10-08.

See Also

• methods::setValidity().

• methods::validObject().

• assertthat::validate_that().

Examples

## TRUE ====
validate(
    is.atomic("example"),
    is.character("example")
)

## FALSE ====
validate(
    isFlag("xxx"),
    isPositive(-1)
)

steinbaugh/goalie documentation built on Jan. 17, 2024, 5:16 p.m.