R/check_non_null.R

In NorwegianVeterinaryInstitute/NVIcheckmate: Extension of checkmate with argument checking adapted for NVIverse

#' @title Check if two or more arguments are NULL or NA
#' @description Check whether two or more arguments that may replace each other are NULL or NA.
#' @details In some functions, one argument may replace another. The check is used to ensure that at
#'     least on of the arguments have a value. Specific checks for each argument should be used in addition.
#' @templateVar fn non_null
#' @param x \[any\]\cr
#'  List with objects to check.
#' @template checker
#' @export
#' @examples
#' data <- NULL
#' nrows_in_data <- 56
#' check_non_null(x = list(data, nrows_in_data))
check_non_null <- function(x) {
  # ARGUMENT CHECKING ----
  # Object to store check-results
  checks <- checkmate::makeAssertCollection()
  # Perform checks
  checkmate::assert_list(x = x, min.len = 2, null.ok = TRUE, add = checks)
  # Report check-results
  checkmate::reportAssertions(checks)

  # PERFORM CHECK ----
  res <- FALSE
  for (i in c(1:length(x))) {
    # if (class(x[[i]]) != "NULL") {res <- TRUE}
    if (!inherits(x[[i]], what = "NULL")) {res <- TRUE}
    # if (!is.null(x[[i]][1])) {
    #   if (!is.na(x[[i]][1])) {res <- TRUE}
    # }
  }
  if (!res) {
    res <- paste0("At least one of the arguments ",
                  # "{'",
                  # paste0(deparse(substitute(x)), collapse = "','"),
                  # "'} ",
                  "must have input different from NULL and NA.")
  }
  return(res)
}

#' @export
#' @include makeAssertionFunction.R
# @template comment
#' @template assert
#' @rdname check_non_null
assert_non_null <- makeAssertionFunction(check_non_null)