assert_character_vector {admiraldev} | R Documentation |
Is an Argument a Character Vector?
Description
Checks if an argument is a character vector
Usage
assert_character_vector(arg, values = NULL, named = FALSE, optional = FALSE)
Arguments
arg |
A function argument to be checked |
values |
A |
named |
If set to |
optional |
Is the checked argument optional? If set to |
Value
The function throws an error if arg
is not a character vector or if
any element is not included in the list of valid values. Otherwise, the input
is returned invisibly.
See Also
Checks for valid input and returns warning or errors messages:
assert_atomic_vector()
,
assert_character_scalar()
,
assert_data_frame()
,
assert_date_vector()
,
assert_expr_list()
,
assert_expr()
,
assert_filter_cond()
,
assert_function()
,
assert_integer_scalar()
,
assert_list_element()
,
assert_list_of()
,
assert_logical_scalar()
,
assert_named()
,
assert_numeric_vector()
,
assert_one_to_one()
,
assert_param_does_not_exist()
,
assert_s3_class()
,
assert_same_type()
,
assert_symbol()
,
assert_unit()
,
assert_vars()
,
assert_varval_list()
Examples
example_fun <- function(chr) {
assert_character_vector(chr)
}
example_fun(letters)
try(example_fun(1:10))
example_fun2 <- function(chr) {
assert_character_vector(chr, named = TRUE)
}
try(example_fun2(c(alpha = "a", "b", gamma = "c")))