R has little support for physical measurement units. The exception is formed by time differences: time differences objects of class difftime have a units attribute that can be modified:

t1 = Sys.time() 
t2 = t1 + 3600 
d = t2 - t1
class(d)
## [1] "difftime"
units(d)
## [1] "hours"
d
## Time difference of 1 hours
units(d) = "secs"
d
## Time difference of 3600 secs

We see here that the units method is used to retrieve and modify the unit of time differences.

The units package generalizes this idea to other physical units, building upon the udunits2 R package, which in turn is build upon the udunits2 C library. The udunits2 library provides the following operations:

The units R package uses R package udunits2 to extend R with functionality for manipulating numeric vectors that have physical measurement units associated with them, in a similar way as difftime objects behave.

Setting units, unit conversion

Existing units are resolved from a database in the units package, called ud_units. We can see the first three elements of it by

library(units)
ud_units[1:3]
## $m
## 1 [m]
## 
## $kg
## 1 [kg]
## 
## $s
## 1 [s]

We can set units to numerical values by set_units:

(a <- set_units(runif(10),  m/s))
## Units: [m/s]
##  [1] 0.36127025 0.43905581 0.99845243 0.19955417 0.27954245 0.86322245
##  [7] 0.83101044 0.08345579 0.13455004 0.29473114

the result, e.g.

set_units(10, m/s)
## 10 [m/s]

literally means “10 times 1 m divided by 1 s”. In writing, the “1” values are omitted, and the multiplication is implicit.

The units package comes with a list of over 3000 predefined units,

length(ud_units)
## [1] 3248

We can retrieve a single unit from the ud_units database by

with(ud_units, km/h)
## 1 [km/h]

Unit conversion

When conversion is meaningful, such as hours to seconds or meters to kilometers, conversion can be done explicitly by setting the units of a vector

b = a
units(b) <- with(ud_units, km/h)
b
## Units: [km/h]
##  [1] 1.3005729 1.5806009 3.5944287 0.7183950 1.0063528 3.1076008 2.9916376
##  [8] 0.3004408 0.4843802 1.0610321

Basic manipulations

Arithmetic operations

Arithmetic operations verify units, and create new ones

a + a
## Units: [m/s]
##  [1] 0.7225405 0.8781116 1.9969049 0.3991083 0.5590849 1.7264449 1.6620209
##  [8] 0.1669116 0.2691001 0.5894623
a * a
## Units: [m^2/s^2]
##  [1] 0.130516192 0.192770002 0.996907248 0.039821869 0.078143983
##  [6] 0.745153000 0.690578352 0.006964869 0.018103714 0.086866447
a ^ 2
## Units: [m^2/s^2]
##  [1] 0.130516192 0.192770002 0.996907248 0.039821869 0.078143983
##  [6] 0.745153000 0.690578352 0.006964869 0.018103714 0.086866447
a ** -2
## Units: [s^2/m^2]
##  [1]   7.661885   5.187529   1.003102  25.111830  12.796891   1.342006
##  [7]   1.448062 143.577723  55.237283  11.511925

and convert to the units of the first argument if necessary:

a + b # m/s + km/h -> m/s
## Units: [m/s]
##  [1] 0.7225405 0.8781116 1.9969049 0.3991083 0.5590849 1.7264449 1.6620209
##  [8] 0.1669116 0.2691001 0.5894623

Currently, powers are only supported for integer powers, so using a ** 2.5 would result in an error.

Unit simplification

There are some basic simplification of units:

t <- with(ud_units, s)
a * t
## Units: [m]
##  [1] 0.36127025 0.43905581 0.99845243 0.19955417 0.27954245 0.86322245
##  [7] 0.83101044 0.08345579 0.13455004 0.29473114

which also work when units need to be converted before they can be simplified:

t <- with(ud_units, min)
a * t
## Units: [m]
##  [1] 21.676215 26.343348 59.907146 11.973250 16.772547 51.793347 49.860626
##  [8]  5.007347  8.073003 17.683869

Simplification to unit-less values gives the “1” as unit:

m <- with(ud_units, m)
a * t / m
## Units: [1]
##  [1] 21.676215 26.343348 59.907146 11.973250 16.772547 51.793347 49.860626
##  [8]  5.007347  8.073003 17.683869

Allowed operations that require convertible units are +, -, ==, !=, <, >, <=, >=. Operations that lead to new units are *, /, and the power operations ** and ^.

Mathematical functions

Mathematical operations allowed are: abs, sign, floor, ceiling, trunc, round, signif, log, cumsum, cummax, cummin.

signif(a ** 2 / 3, 3)
## Units: [m^2/s^2]
##  [1] 0.04350 0.06430 0.33200 0.01330 0.02600 0.24800 0.23000 0.00232
##  [9] 0.00603 0.02900
cumsum(a)
## Units: [m/s]
##  [1] 0.3612702 0.8003261 1.7987785 1.9983327 2.2778751 3.1410976 3.9721080
##  [8] 4.0555638 4.1901138 4.4848450
log(a) # base defaults to exp(1)
## Units: [(ln(re 1 m.s-1))]
##  [1] -1.018128993 -0.823128750 -0.001548772 -1.611669527 -1.274601109
##  [6] -0.147082856 -0.185112920 -2.483438256 -2.005819074 -1.221691717
log(a, base = 10)
## Units: [(lg(re 1 m.s-1))]
##  [1] -0.4421678034 -0.3574802740 -0.0006726233 -0.6999391823 -0.5535522284
##  [6] -0.0638772729 -0.0803935198 -1.0785435307 -0.8711161556 -0.5305739714
log(a, base = 2)
## Units: [(lb(re 1 m.s-1))]
##  [1] -1.468849649 -1.187523766 -0.002234406 -2.325147635 -1.838860699
##  [6] -0.212195708 -0.267061492 -3.582844056 -2.893785231 -1.762528582

Summary functions

Summary functions sum, min, max, and range are allowed:

sum(a)
## 4.484845 [m/s]
min(a)
## 0.08345579 [m/s]
max(a)
## 0.9984524 [m/s]
range(a)
## Units: [m/s]
## [1] 0.08345579 0.99845243
with(ud_units, min(m/s, km/h)) # converts to first unit:
## 0.2777778 [m/s]

Printing

Following difftime, printing behaves differently for length-one vectors:

a
## Units: [m/s]
##  [1] 0.36127025 0.43905581 0.99845243 0.19955417 0.27954245 0.86322245
##  [7] 0.83101044 0.08345579 0.13455004 0.29473114
a[1]
## 0.3612702 [m/s]

Subsetting

The usual subsetting rules work:

a[2:5]
## Units: [m/s]
## [1] 0.4390558 0.9984524 0.1995542 0.2795425
a[-(1:9)]
## 0.2947311 [m/s]

Concatenation

c(a,a)
## Units: [m/s]
##  [1] 0.36127025 0.43905581 0.99845243 0.19955417 0.27954245 0.86322245
##  [7] 0.83101044 0.08345579 0.13455004 0.29473114 0.36127025 0.43905581
## [13] 0.99845243 0.19955417 0.27954245 0.86322245 0.83101044 0.08345579
## [19] 0.13455004 0.29473114

concatenation converts to the units of the first argument, if necessary:

c(a,b) # m/s, km/h -> m/s
## Units: [m/s]
##  [1] 0.36127025 0.43905581 0.99845243 0.19955417 0.27954245 0.86322245
##  [7] 0.83101044 0.08345579 0.13455004 0.29473114 0.36127025 0.43905581
## [13] 0.99845243 0.19955417 0.27954245 0.86322245 0.83101044 0.08345579
## [19] 0.13455004 0.29473114
c(b,a) # km/h, m/s -> km/h
## Units: [km/h]
##  [1] 1.3005729 1.5806009 3.5944287 0.7183950 1.0063528 3.1076008 2.9916376
##  [8] 0.3004408 0.4843802 1.0610321 1.3005729 1.5806009 3.5944287 0.7183950
## [15] 1.0063528 3.1076008 2.9916376 0.3004408 0.4843802 1.0610321

Conversion to/from difftime

From difftime to units:

t1 = Sys.time() 
t2 = t1 + 3600 
d = t2 - t1
(du = as_units(d))
## 1 [h]

vice versa:

(dt = as_difftime(du))
## Time difference of 1 hours
class(dt)
## [1] "difftime"

units in matrix objects

set_units(matrix(1:4,2,2), m/s)
## Units: [m/s]
##      [,1] [,2]
## [1,]    1    3
## [2,]    2    4
set_units(matrix(1:4,2,2), m/s * m/s)
## Units: [m^2/s^2]
##      [,1] [,2]
## [1,]    1    3
## [2,]    2    4

but

set_units(matrix(1:4,2,2), m/s) %*% set_units(4:3, m/s)
##      [,1]
## [1,]   13
## [2,]   20

strips units.

units objects in data.frames

units in data.frame objects are printed, but do not appear in summary:.

set.seed(131)
d <- data.frame(x = runif(4), 
                    y = set_units(runif(4), s), 
                    z = set_units(1:4, m/s))
d
##           x             y       z
## 1 0.2064370 0.8463468 [s] 1 [m/s]
## 2 0.1249422 0.5292048 [s] 2 [m/s]
## 3 0.2932732 0.5186254 [s] 3 [m/s]
## 4 0.3757797 0.2378545 [s] 4 [m/s]
summary(d)
##        x                y                z       
##  Min.   :0.1249   Min.   :0.2379   Min.   :1.00  
##  1st Qu.:0.1861   1st Qu.:0.4484   1st Qu.:1.75  
##  Median :0.2499   Median :0.5239   Median :2.50  
##  Mean   :0.2501   Mean   :0.5330   Mean   :2.50  
##  3rd Qu.:0.3139   3rd Qu.:0.6085   3rd Qu.:3.25  
##  Max.   :0.3758   Max.   :0.8463   Max.   :4.00
d$yz = with(d, y * z)
d
##           x             y       z            yz
## 1 0.2064370 0.8463468 [s] 1 [m/s] 0.8463468 [m]
## 2 0.1249422 0.5292048 [s] 2 [m/s] 1.0584095 [m]
## 3 0.2932732 0.5186254 [s] 3 [m/s] 1.5558761 [m]
## 4 0.3757797 0.2378545 [s] 4 [m/s] 0.9514180 [m]
d[1, "yz"]
## 0.8463468 [m]

formatting

Units are often written in the form m2 s-1, for square meter per second. This can be defined as unit, and also parsed by as_units:

(x = 1:10 * as_units("m2 s-1"))
## Units: [m^2/s]
##  [1]  1  2  3  4  5  6  7  8  9 10

udunits understands such string, and can convert them

y = 1:10 * with(ud_units, m^2/s)
x + y
## Units: [m^2/s]
##  [1]  2  4  6  8 10 12 14 16 18 20

Printing units in this form is done by

deparse_unit(x)
## [1] "m2 s-1"

plotting

Base scatter plots and histograms support automatic unit placement in axis labels. In the following example we first convert to SI units. (Unit in needs a bit special treatment, because in is a reserved word in R.)

mar = par("mar") + c(0, .3, 0, 0)
displacement = mtcars$disp * ud_units[["in"]]^3
units(displacement) = with(ud_units, cm^3)
weight = mtcars$wt * 1000 * with(ud_units, lb)
units(weight) = with(ud_units, kg)
par(mar = mar)
plot(weight, displacement)

We can change grouping symbols from [ ] into ( ):

units_options(group = c("(", ")") )  # parenthesis instead of square brackets
par(mar = mar)
plot(weight, displacement)

We can also remove grouping symbols, increase space between variable name and unit by:

units_options(sep = c("~~~", "~"), group = c("", ""))  # no brackets; extra space
par(mar = mar)
plot(weight, displacement)

More complex units can be plotted either with negative powers, or as divisions, by modifying one of units’s global options using units_options:

gallon = as_units("gallon")
consumption = mtcars$mpg * with(ud_units, mi/gallon)
units(consumption) = with(ud_units, km/l)
par(mar = mar)
plot(displacement, consumption) # division in consumption

units_options(negative_power = TRUE) # division becomes ^-1
plot(displacement, consumption) # division in consumption

As usual, units modify automatically in expressions:

units_options(negative_power = TRUE) # division becomes ^-1
par(mar = mar)
plot(displacement, consumption)

plot(1/displacement, 1/consumption)