R/assert.R

In AstraZeneca/qscheck: qscheck

#' Shorter version of assertthat::assert_that
#'
#' @param \dots Passthrough to assertthat::assert_that
#' @param env environment on which to apply the assertion
#' @param msg overrides the error message, if specified.
#'
#' @concept assert
#' @export
assert <- function(..., env = parent.frame(), msg = NULL) {
  assertthat::assert_that(..., env = env, msg = msg)
}

#' Returns just the error message or NULL if no error.
#'
#' @param \dots Condition to test
#' @param env environment on which to apply the assertion
#' @param msg overrides the error message, if specified.
#'
#' @concept assert
#' @export
message <- function(..., env = parent.frame(), msg = NULL) {
  res <- assertthat::validate_that(..., env = env, msg = msg)
  if (res == TRUE) {
    return(NULL)
  }
  return(res)
}

#' Returns the error message if fails or TRUE if successful.
#' Useful in S4 validation.
#'
#' @param \dots Condition to test
#' @param env environment on which to apply the assertion
#' @param msg overrides the error message, if specified.
#'
#' @concept assert
#' @export
validate <- function(..., env = parent.frame(), msg = NULL) {
  res <- assertthat::validate_that(..., env = env, msg = msg)
  return(res)
}