Skip to contents

Create a specified time-of-day stabilizer function

Source: R/specify_time.R
specify_time.Rd

specify_time() creates a function that will call stabilize_time() with the provided arguments. specify_time_scalar() creates a function that will call stabilize_time_scalar() with the provided arguments.

Usage

specify_time(
  allow_null = TRUE,
  allow_na = TRUE,
  min_size = NULL,
  max_size = NULL,
  unique = FALSE,
  min_value = NULL,
  max_value = NULL,
  allowed_values = NULL
)

specify_time_scalar(
  allow_null = FALSE,
  allow_zero_length = FALSE,
  allow_na = TRUE,
  min_value = NULL,
  max_value = NULL,
  allowed_values = NULL
)

Arguments

allow_null

(logical(1)) Is NULL an acceptable value?

allow_na

(logical(1)) Are NA values ok?

min_size

(integer(1)) The minimum size of the object. Object size will be tested using vctrs::vec_size().

max_size

(integer(1)) The maximum size of the object. Object size will be tested using vctrs::vec_size().

unique

(logical(1)) Should all elements in x be distinct?

min_value

(numeric(1)) The lowest allowed value for x. If NULL (default) values are not checked.

max_value

(numeric(1)) The highest allowed value for x. If NULL (default) values are not checked.

allowed_values

A vector of permitted values (coerced to the target type). NULL (default) skips the check. NA values in x are permitted independently of allowed_values, subject to allow_na.

allow_zero_length

(logical(1)) Are zero-length vectors acceptable?

Value

A function of class "stbl_specified_fn" that calls stabilize_time() or stabilize_time_scalar() with the provided arguments. The generated function will also accept ... for additional arguments to pass to stabilize_time() or stabilize_time_scalar(). You can copy/paste the body of the resulting function if you want to provide additional context or functionality.

See also

Other time functions: stabilize_time(), stabilize_time_scalar(), to_time(), to_time_scalar()

Other specification functions: specify_chr(), specify_date(), specify_dbl(), specify_df(), specify_dttm(), specify_dur(), specify_fct(), specify_int(), specify_lgl(), specify_lst()

Examples

stabilize_afternoon <- specify_time(min_value = "12:00:00Z")
stabilize_afternoon("13:00:00Z")
#> 13:00:00
try(stabilize_afternoon("06:00:00Z"))
#> Error in eval(expr, envir) : `"06:00:00Z"` must be >= 12:00:00.
#> ✖ "06:00:00" is too low.