assert_date_vector {admiraldev}

Is an object a date or datetime vector?

Description

Check if an object/vector is a date or datetime variable without needing a dataset as input

Usage

assert_date_vector(arg, optional = FALSE)

Arguments

arg

The function argument to be checked

optional

Is the checked argument optional? If set to FALSE and arg is NULL then the function assert_date_vector exits early and throw and error.

Value

The function returns an error if arg is missing, or not a date or datetime variable but otherwise returns an invisible output.

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_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(arg) {
  assert_date_vector(arg)
}

example_fun(
  as.Date("2022-01-30", tz = "UTC")
)
try(example_fun("1993-07-14"))