Assert that strings have at most a maximum number of characters

Checks that x is a character vector in which every element has at most maximum_characters characters. Missing values cause the check to fail.

Usage

assert_maximum_characters(
  x,
  maximum_characters,
  null_ok = FALSE,
  arg = rlang::caller_arg(x),
  call = rlang::caller_env()
)

Arguments

x

Object to check.

maximum_characters

Single non-negative whole number: the largest allowed number of characters.

null_ok

Single logical. If TRUE, a NULL value passes the check without error. Use this for optional arguments that default to NULL. Defaults to FALSE, so NULL is rejected unless you opt in.

arg

Name used to refer to x in error messages. Defaults to the name of the expression passed as x.

call

Environment used as the error's call context. Defaults to the calling function, so errors point at the user's code.

Value

The input x, invisibly.

Examples

assert_maximum_characters(c("abc", "ab"), 3)