Apply a function keeping units

Helper function to apply a function to a units object and then restore the original units.

Usage

keep_units(FUN, x, ..., unit = units(x))

Arguments

FUN

the function to be applied.

x

first argument of FUN, of class units.

...

optional arguments to FUN.

unit

symbolic unit to restore after FUN.

Value

An object of class units.

Details

Provided for incompatible functions that do not preserve units. The user is responsible for ensuring the correctness of the output.

Examples

x <- set_units(1:5, m)
keep_units(drop_units, x)
#> Units: [m]
#> [1] 1 2 3 4 5