R/check-give.R

In JeroenDMulder/powRICLPM: Perform Power Analysis for the RI-CLPM and STARTS Model

#' Check \code{what} Argument
#'
#' \code{check_give} checks the \code{what} argument of \code{give()} by testing if it is a character string of length 1.
#'
#' @param x A character string of length 1.
#'
#' @noRd
icheck_what_give <- function(x, arg = rlang::caller_arg(x), call = rlang::caller_env()) {
  if (!is.character(x)) {
    cli::cli_abort(
      c(
        "{.arg {arg}} must be a character string:",
        "x" = "Your {.arg {arg}} is a {typeof(arg)}."
      ),
      call = call
    )
  }

  if (length(x) > 1) {
    cli::cli_abort(
      c(
        "{.arg {arg}} must be of length 1:",
        "x" = "Your {.arg {arg}} is of length {.value length(arg)}."
      )
    )
  }

  if (!any(x == c("conditions", "estimation_problems", "results", "names"))) {
    cli::cli_abort(
      c(
        "{.arg {arg}} is not an accepted input. Please change it to `conditions`, `estimation_problems`, `results`, or `names`.",
        "x" = "Your {.arg {arg}} is {print(arg)}."
      ),
      call = call
    )
  }
}