Skip to contents

Assert Argument is a Named List or Vector

Source: R/assertions.R
assert_named.Rd

Assert that all elements of the argument are named.

Usage

assert_named(arg, optional = FALSE)

Arguments

arg

A function argument to be checked

optional

Is the checked argument optional? If set to FALSE and arg is NULL then an error is thrown

Value

The function throws an error if arg is not a named list or vector or returns the input invisibly otherwise

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_list(), assert_expr(), assert_filter_cond(), assert_function(), assert_integer_scalar(), assert_list_element(), assert_list_of(), assert_logical_scalar(), 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(varval_list) {
  assert_named(varval_list)
}

example_fun(list(var1 = 1, var2 = "x"))

try(example_fun(list(1, "x")))
#> Error in assert_named(varval_list) : 
#>   All elements of `varval_list` must be named.
#> No element is named.

try(example_fun(list(var = 1, "x")))
#> Error in assert_named(varval_list) : 
#>   All elements of `varval_list` must be named.
#> The following elements are not named: 2