General utility functions for working with distance units objects
Source:R/get_dist_units.R
is_dist_units.Rd
is_dist_units()
: Is x a units object with a units attribute indist_unit_options
orarea_unit_options
?get_dist_units()
: Get the distance units from x (if x is a sf or units objects or a character string from dist_unit_options)as_dist_units()
: Convert x to units using units::as_unitsis_same_units()
: Do x and y have the same distance units attribute? Names or symbols of valid distance units are allowed.
Usage
is_dist_units(x, arg = caller_arg(x))
get_dist_units(x, arg = caller_arg(x), call = parent.frame())
as_dist_units(x, units = NULL, arg = caller_arg(x), call = parent.frame())
is_same_units(x, y = NULL)
Arguments
- x, y
objects to check
- arg
Used internally and passed to
rlang::arg_match()
as error arg or used bycli::cli_abort()
to improve error messages.- call
The execution environment of a currently running function, e.g.
caller_env()
. The function will be mentioned in error messages as the source of the error. See thecall
argument ofabort()
for more information.- units
Distance units to convert to. Must be one of dist_unit_options or area_unit_options.
See also
Other dist:
convert_dist_scale()
,
convert_dist_units()
Examples
mile <- units::set_units(1, "mi")
is_dist_units("mi")
#> [1] FALSE
is_dist_units(mile)
#> [1] TRUE
is_same_units(mile, "mile")
#> [1] TRUE
get_dist_units(mile)
#> [1] "mi"
as_dist_units(1, "mi")
#> 1 [mi]
as_dist_units(2, mile)
#> 2 [mi]