assert_expr_list {admiraldev} | R Documentation |
Is an Argument a List of Expressions?
Description
Checks if the argument is a list of expressions.
Usage
assert_expr_list(
arg,
required_elements = NULL,
named = FALSE,
optional = FALSE,
arg_name = rlang::caller_arg(arg),
message = NULL,
class = "assert_expr_list",
call = parent.frame()
)
Arguments
arg |
A function argument to be checked |
required_elements |
A |
named |
If set to |
optional |
Is the checked argument optional? If set to |
arg_name |
string indicating the label/symbol of the object being checked. |
message |
string passed to |
class |
Subclass of the condition. |
call |
The execution environment of a currently running
function, e.g. You only need to supply Can also be For more information about error calls, see Including function calls in error messages. |
Value
The function throws an error if arg
is not a list of expressions.
Otherwise, the input it returned invisibly.
See Also
Checks for valid input and returns warning or errors messages:
assert_atomic_vector()
,
assert_character_scalar()
,
assert_character_vector()
,
assert_data_frame()
,
assert_date_vector()
,
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
library(rlang)
example_fun <- function(vars) {
assert_expr_list(vars)
}
example_fun(exprs(DTHDOM = "AE", DTHSEQ = AESEQ))
try(example_fun(exprs("AE", DTSEQ = AESEQ, !!list("a"), !!list("a"))))