Checks whether a vector can be coerced to an hms::hms() time-of-day vector
without losing information, returning it silently if so. Otherwise an
informative error message is signaled.
Usage
to_time(
x,
...,
x_arg = caller_arg(x),
call = caller_env(),
x_class = object_type(x)
)
# S3 method for class '`NULL`'
to_time(x, ..., allow_null = TRUE, x_arg = caller_arg(x), call = caller_env())
# S3 method for class 'character'
to_time(
x,
...,
x_arg = caller_arg(x),
call = caller_env(),
x_class = object_type(x)
)
# S3 method for class 'factor'
to_time(
x,
...,
x_arg = caller_arg(x),
call = caller_env(),
x_class = object_type(x)
)
# S3 method for class 'POSIXct'
to_time(x, ..., call = caller_env())
# S3 method for class 'POSIXlt'
to_time(x, ..., call = caller_env())
# S3 method for class 'numeric'
to_time(
x,
...,
x_arg = caller_arg(x),
call = caller_env(),
x_class = object_type(x)
)
# S3 method for class 'integer'
to_time(
x,
...,
x_arg = caller_arg(x),
call = caller_env(),
x_class = object_type(x)
)
# S3 method for class 'difftime'
to_time(
x,
...,
x_arg = caller_arg(x),
call = caller_env(),
x_class = object_type(x)
)Arguments
- x
The object to stabilize.
- ...
Arguments passed to methods.
- 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.- allow_null
(
logical(1)) Is NULL an acceptable value?
Value
The input as an hms::hms() vector, always expressed in UTC.
Details
Character vectors must use the RFC 3339 full-time format
("HH:MM:SS", optionally followed by fractional seconds and a mandatory
offset of either "Z" or a numeric offset such as "+05:00"); any other
shape is rejected. The offset is used only to normalize the value to UTC and
is not retained: to_time() always returns the time-of-day expressed in UTC.
base::POSIXct and base::POSIXlt values are likewise converted to UTC
before their time-of-day component is extracted. Numeric and base::difftime
values are treated as (fractional) seconds since midnight and must resolve to
a value in [0, 86400).
to_time() requires the hms package.
See also
Other time functions:
specify_time(),
stabilize_time(),
stabilize_time_scalar(),
to_time_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_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_scalar()
Examples
to_time(hms::hms(0, 20, 13))
#> 13:20:00
to_time("13:20:00Z")
#> 13:20:00
to_time("13:20:00-05:00")
#> 18:20:00
to_time(c("13:20:00Z", NA))
#> 13:20:00
#> NA
to_time(3600)
#> 01:00:00
to_time(as.POSIXct("2024-01-01 13:20:00", tz = "UTC"))
#> 13:20:00
to_time(NULL)
#> NULL
try(to_time("13:20:00"))
#> Error in eval(expr, envir) :
#> `"13:20:00"` <character> must be coercible to <time>
#> ✖ Can't convert some values due to invalid or ambiguous time format.
#> • Locations: 1
#> • Values: "13:20:00"
try(to_time(c("13:20:00Z", "not-a-time")))
#> Error in eval(expr, envir) :
#> `c("13:20:00Z", "not-a-time")` <character> must be coercible to <time>
#> ✖ Can't convert some values due to invalid or ambiguous time format.
#> • Locations: 2
#> • Values: "not-a-time"