R/chk-string.R

In chk: Check User-Supplied Function Arguments

#' Check String
#'
#' @description
#' Checks if string
#'
#' `is.character(x) && length(x) == 1L && !anyNA(x)`
#'
#' @inheritParams params
#' @inherit params return
#'
#' @family chk_scalars
#'
#' @examples
#' # chk_string
#' chk_string("1")
#' try(chk_string(1))
#' @export
chk_string <- function(x, x_name = NULL) {
  if (vld_string(x)) {
    return(invisible(x))
  }
  if (is.null(x_name)) x_name <- deparse_backtick_chk(substitute(x))
  abort_chk(x_name, " must be a string (non-missing character scalar)", x = x)
}

#' @describeIn chk_string Validate String
#'
#' @examples
#' # vld_string
#' vld_string("1")
#' vld_string("")
#' vld_string(1)
#' vld_string(NA_character_)
#' vld_string(c("1", "1"))
#' @export
vld_string <- function(x) {
  is.character(x) && length(x) == 1L && !anyNA(x)
}