Convert between common units — convert

convert_units is a wrapper around units::set_units() to switch between common measurement units.

Usage

convert_units(x, from = NULL, to = NULL, keep_units = NULL, ...)

Arguments

x: A numeric vector.
from, to: A string indicating the current/desired unit of x. Run units::valid_udunits() for a list of valid units for your system. If from is NULL (default), tries to get units from x and fails if x does not have a units attribute. If to is NULL, units::convert_to_base() is used to convert to pre-defined base units for the from unit.
keep_units: A logical value (or NULL) indicating whether to keep the units after conversion. Default is NULL, which is TRUE if x has a units attribute, FALSE otherwise.
...: Additional arguments passed on to units::set_units()

Value

A numeric vector with the same length/type as x. If keep_units = TRUE, the units attribute is preserved

Examples

convert_units(c(1, 2, 3), from = "cm", to = "km")
#> [1] 1e-05 2e-05 3e-05
convert_units(c(1, 2, 3), from = "degF", to = "degC")
#> [1] -17.22222 -16.66667 -16.11111
convert_units(c(1, 2, 3), from = "ft", to = "m")
#> [1] 0.3048 0.6096 0.9144
convert_units(c(1, 2, 3), from = "oz", to = "L")
#> [1] 0.02957353 0.05914706 0.08872059
convert_units(c(1, 2, 3), from = "m/s", to = "km/h")
#> [1]  3.6  7.2 10.8
convert_units(c(1, 2, 3), from = "ug/m3", to = "mg/km3")
#> [1] 1e+06 2e+06 3e+06
1:5 |> units::set_units("cm") |> convert_units(to = "km")
#> Units: [km]
#> [1] 1e-05 2e-05 3e-05 4e-05 5e-05
1:5 |> units::set_units("cm") |> convert_units()
#> Units: [m]
#> [1] 0.01 0.02 0.03 0.04 0.05