R/validate.R

Defines functions validate

Documented in validate

#' Generic validation method
#'
#' This function is used to perform assertions that an object
#' conforms to its expected structure and no basic assumptions
#' have been violated. Will throw an error if checks do not pass.
#'
#' @param x object to be validated.
#' @param ... additional arguments to pass to the specific validation method.
#'
#' @export
validate <- function(x, ...) {
    UseMethod("validate")
}
insightsengineering/rbmi documentation built on Feb. 28, 2025, 3:34 a.m.