Skip to contents

Coerce to length-1 duration with additional checks

Source: R/stabilize_dur.R
stabilize_dur_scalar.Rd

Checks whether a vector can be coerced to a length-1 lubridate::Period vector. stabilize_dur_scalar() is optimized to check for length-1 duration vectors (compared to stabilize_dur() with max_size = 1). stabilise_dur_scalar, stabilize_duration_scalar, and stabilise_duration_scalar are synonyms of stabilize_dur_scalar().

Usage

stabilize_dur_scalar(
  x,
  ...,
  allow_null = FALSE,
  allow_zero_length = FALSE,
  allow_na = TRUE,
  min_value = NULL,
  max_value = NULL,
  allowed_values = NULL,
  x_arg = caller_arg(x),
  call = caller_env(),
  x_class = object_type(x)
)

stabilise_dur_scalar(
  x,
  ...,
  allow_null = FALSE,
  allow_zero_length = FALSE,
  allow_na = TRUE,
  min_value = NULL,
  max_value = NULL,
  allowed_values = NULL,
  x_arg = caller_arg(x),
  call = caller_env(),
  x_class = object_type(x)
)

stabilize_duration_scalar(
  x,
  ...,
  allow_null = FALSE,
  allow_zero_length = FALSE,
  allow_na = TRUE,
  min_value = NULL,
  max_value = NULL,
  allowed_values = NULL,
  x_arg = caller_arg(x),
  call = caller_env(),
  x_class = object_type(x)
)

stabilise_duration_scalar(
  x,
  ...,
  allow_null = FALSE,
  allow_zero_length = FALSE,
  allow_na = TRUE,
  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_zero_length

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

allow_na

(logical(1)) Are NA values ok?

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 length-1 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_empty> for empty vectors when allow_zero_length = FALSE.

  • <stbl-error-non_scalar> for non-scalar vectors.

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

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

  • <stbl-error-allowed_values> when the value is not in allowed_values.

See also

Other duration functions: specify_dur(), stabilize_dur(), 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(), 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_scalar(lubridate::period(day = 1))
#> [1] "1d 0H 0M 0S"
stabilize_dur_scalar("P1D")
#> [1] "1d 0H 0M 0S"
try(stabilize_dur_scalar(c("P1D", "P2D")))
#> Error in eval(expr, envir) : 
#>   `c("P1D", "P2D")` must be a single <Period>.
#> ✖ `c("P1D", "P2D")` has 2 values.
try(stabilize_dur_scalar(NULL))
#> Error in eval(expr, envir) : `NULL` must not be <NULL>.
stabilize_dur_scalar(NULL, allow_null = TRUE)
#> NULL