Skip to contents

Coerce to duration with additional checks

Source: R/stabilize_dur.R
stabilize_dur.Rd

Compared to to_dur(), stabilize_dur() checks more details, but is slower. stabilise_dur(), stabilize_duration(), and stabilise_duration() are synonyms of stabilize_dur().

Usage

stabilize_dur(
  x,
  ...,
  allow_null = TRUE,
  allow_na = TRUE,
  min_size = NULL,
  max_size = NULL,
  unique = FALSE,
  min_value = NULL,
  max_value = NULL,
  allowed_values = NULL,
  x_arg = caller_arg(x),
  call = caller_env(),
  x_class = object_type(x)
)

stabilise_dur(
  x,
  ...,
  allow_null = TRUE,
  allow_na = TRUE,
  min_size = NULL,
  max_size = NULL,
  unique = FALSE,
  min_value = NULL,
  max_value = NULL,
  allowed_values = NULL,
  x_arg = caller_arg(x),
  call = caller_env(),
  x_class = object_type(x)
)

stabilize_duration(
  x,
  ...,
  allow_null = TRUE,
  allow_na = TRUE,
  min_size = NULL,
  max_size = NULL,
  unique = FALSE,
  min_value = NULL,
  max_value = NULL,
  allowed_values = NULL,
  x_arg = caller_arg(x),
  call = caller_env(),
  x_class = object_type(x)
)

stabilise_duration(
  x,
  ...,
  allow_null = TRUE,
  allow_na = TRUE,
  min_size = NULL,
  max_size = NULL,
  unique = FALSE,
  min_value = NULL,
  max_value = NULL,
  allowed_values = NULL,
  x_arg = caller_arg(x),
  call = caller_env(),
  x_class = object_type(x)
)

Arguments

x

The object to stabilize.

...

Arguments passed to methods.

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.

x_arg

(character(1)) The name of the object being stabilized to use in error messages. The automatic value will work in most cases, or pass it through from higher-level functions to make error messages clearer in unexported functions.

call

(environment) The execution environment to mention as the source of error messages.

x_class

(character(1)) The class name of the object being stabilized to use in error messages. Use this if you remove a special class from the object before checking its coercion, but want the error message to match the original class.

Value

The input as a lubridate::Period vector, or an error condition with classes <stbl-error>, <stbl-condition>, <rlang_error>, <error>, <condition>, and a specific class by failure mode:

  • <stbl-error-coerce-duration> when x cannot be coerced to a duration.

  • <stbl-error-incompatible_values-duration> when some values cannot be safely converted to a duration.

  • <stbl-error-bad_null> for NULL values when allow_null = FALSE.

  • <stbl-error-bad_na> for NA values when allow_na = FALSE.

  • <stbl-error-size_too_small> when the vector is shorter than min_size.

  • <stbl-error-size_too_large> when the vector is longer than max_size.

  • <stbl-error-duplicate_elements> when unique = TRUE and duplicates are present.

  • <stbl-error-outside_range> when values fall outside min_value or max_value.

  • <stbl-error-allowed_values> when values are not in allowed_values.

Details

min_value, max_value, and allowed_values comparisons rely on lubridate's approximate, nominal lengths for years and months (see to_dur()); treat range checks on calendar-aware durations as approximate.

See also

Other duration functions: specify_dur(), stabilize_dur_scalar(), to_dur(), to_dur_scalar()

Other stabilization functions: assert_present(), stabilize_any_of(), stabilize_arg(), stabilize_chr(), stabilize_chr_scalar(), stabilize_date(), stabilize_date_scalar(), stabilize_dbl(), stabilize_dbl_scalar(), stabilize_df(), stabilize_dttm(), stabilize_dttm_scalar(), stabilize_dur_scalar(), stabilize_fct(), stabilize_fct_scalar(), stabilize_int(), stabilize_int_scalar(), stabilize_lgl(), stabilize_lgl_scalar(), stabilize_lst(), stabilize_time(), stabilize_time_scalar(), to_chr(), to_chr_scalar(), to_date(), to_date_scalar(), to_dbl(), to_dbl_scalar(), to_dttm(), to_dttm_scalar(), to_dur(), to_dur_scalar(), to_fct(), to_fct_scalar(), to_int(), to_int_scalar(), to_lgl(), to_lgl_scalar(), to_time(), to_time_scalar()

Examples

stabilize_dur(lubridate::period(day = 1))
#> [1] "1d 0H 0M 0S"
stabilize_dur("P3Y6M4DT12H30M5S")
#> [1] "3y 6m 4d 12H 30M 5S"
stabilize_dur(NULL)
#> NULL
try(stabilize_dur(NULL, allow_null = FALSE))
#> Error in eval(expr, envir) : `NULL` must not be <NULL>.
try(stabilize_dur(c("P1D", NA), allow_na = FALSE))
#> Error in eval(expr, envir) : 
#>   `c("P1D", NA)` must not contain NA values.
#> • NA locations: 2
try(stabilize_dur("P"))
#> Error in eval(expr, envir) : 
#>   `"P"` <character> must be coercible to <duration>
#> ✖ Can't convert some values due to invalid or ambiguous duration format.
#> • Locations: 1
#> • Values: "P"
try(stabilize_dur("P1D", min_value = "P2D"))
#> Error in eval(expr, envir) : `"P1D"` must be >= 2d 0H 0M 0S.
#> ✖ "1d 0H 0M 0S" is too low.
try(stabilize_dur("P2D", max_value = "P1D"))
#> Error in eval(expr, envir) : `"P2D"` must be <= 1d 0H 0M 0S.
#> ✖ "2d 0H 0M 0S" is too high.