R/base_check.R

In kristianSN/checkR: What the Package Does (One Line, Title Case)

#' check helper
#'
#' @param check boolean statement to check
#' @param x the variable to check
#' @param input_name the name of the input we are checking
#' @param var_name the variable name the user gave the input
#' @param expected a string describing what the input should be
#' @param call the call environment
#' @param class the class of the error
#' @param allow_null allow check to pass if x is null
#' @param allow_na allow check to pass if any element of x is na
#'
#' @return invisible true/falses
error_on_false <- function(
    check
    , x
    , var_name
    , input_name
    , allow_null
    , allow_na
    , expected
    , call
    , class
){

  if (allow_null & is.null(x)){
    return(invisible(TRUE))
  }

  if (!allow_na & any(is.na(x))){
    na_check <- FALSE
  } else {
    na_check <- TRUE
  }

  if (!check & na_check){
    cli::cli_abort(c(
      "!" = "{.var {input_name}} must be {expected}",
      "i" = "{.var {var_name}} is {.val {x}}"
    )
    , call  = call
    , class = class
    )

    invisible(FALSE)
  } else {
    invisible(TRUE)
  }

}