Skip to contents

Raise conditions stored in validation objects

Source: R/check_for_errors.R
check_for_errors.Rd

Checks validation objects for errors and raises conditions if any are found. Works with hub_validations and hub_validations_collection objects, as well as their subclasses (target_validations and target_validations_collection). Can be used in CI workflows to signal validation failures, or locally to summarise validation results.

Usage

check_for_errors(x, verbose = FALSE, show_warnings = FALSE)

Arguments

x

A hub_validations or hub_validations_collection object (including subclasses target_validations and target_validations_collection).

verbose

Logical. If TRUE, print the results of all checks prior to raising condition and summarising validation object check results.

show_warnings

Logical. If TRUE, print check-level warnings inline with their checks. Validation-level warnings are always printed. Default FALSE.

Value

An error if one of the elements of x is of class check_failure, check_error, check_exec_error or check_exec_warning. TRUE invisibly otherwise.

Details

For more details on these classes, see article on <hub_validations> S3 class objects.

See also

validate_submission(), validate_pr(), validate_target_submission(), validate_target_pr()