assert_atomic_vector {admiraldev} | R Documentation |
Is an Argument an Atomic Vector?
Description
Checks if an argument is an atomic vector
Usage
assert_atomic_vector(arg, optional = FALSE)
Arguments
arg |
A function argument to be checked |
optional |
Is the checked argument optional? If set to |
Value
The function throws an error if arg
is not an atomic vector.
Otherwise, the input is returned invisibly.
See Also
Checks for valid input and returns warning or errors messages:
assert_character_scalar()
,
assert_character_vector()
,
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(x) {
assert_atomic_vector(x)
}
example_fun(1:10)
try(example_fun(list(1, 2)))