R/check_params.R

In octopusR: Interact with the 'Octopus Energy' API

#' Check a datetime argument is in a suitable format
#'
#' @description Check if a given argument is of a proper ISO 8601 format e.g.
#'  `2023-03-02T21:26:10Z`. If not it will give an informative error message.
#'
#' @param arg_date The argument to check
#'
#' @keywords internal
#'
#' @return NULL
check_datetime_format <- function(arg_date) {
  arg <- rlang::caller_arg(arg_date)
  call <- rlang::caller_env()
  if (!inherits(arg_date, "character") &&
    !inherits(arg_date, "Date")) {
    cli::cli_abort(
      "{.arg {arg}} must be {.cls character} or {.cls Date}, not {.cls {class(arg_date)}}.",
      call = call
    )
  }
  iso_8601_pattern <-
    "^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$"

  if (!grepl(iso_8601_pattern, arg_date, perl = TRUE)) {
    cli::cli_abort(
      c(
        "{.arg {arg}} must be in [ISO_8601](https://en.wikipedia.org/wiki/ISO_8601) format.",
        ">" = "For example {.val {Sys.Date()}} or {.val {Sys.time()}}."
      ),
      call = call
    )
  }
}

#' Check a logical argument is in a suitable format
#'
#' @description Check if a given argument is of a logical. If not it will give
#' an informative error message.
#'
#' @param arg_lgl The argument to check
#'
#' @keywords internal
#'
#' @return NULL
check_logical <- function(arg_lgl) {
  arg <- rlang::caller_arg(arg_lgl)
  call <- rlang::caller_env()
  if (!inherits(arg_lgl, "logical")) {
    cli::cli_abort("{.arg {arg}} must be {.cls logical}, not {.cls {class(arg_lgl)}}.",
      call = call
    )
  }
}