qOperations: Quantity operations

In Pisca46/quantities: Quantities and print support

Description

Quantity operations

Usage

qSum(..., na.rm = FALSE, unit = NULL)

qMax(..., na.rm = FALSE, unit = NULL)

qMin(..., na.rm = FALSE, unit = NULL)

qInv(x)

qProd(..., na.rm = FALSE, unit = NULL)

qDiv(x, y, na.rm = FALSE, unit = NULL)

sameQdim(...)

qUnlist(ql, skipNull = TRUE, unit = NULL)

Arguments

...	a number of quantities (or numerics depending on the operation)
na.rm	logical. Should missing values be removed?
unit	a character string or vector with a unit specification
x, y	a quantity or a numeric
ql	a list of quantities and, eventually, NULLs
skipNull	logical Skip NULL elements in unlist

Details

sameQdim test whether or not two quantities have the same dimension. There scale may differ.

the Q equivalent for unlist. All non-NULL elements must have the same dimension and all scales are converted to the scale of the first element.

Examples

x <- as.quantity (2, 'time$day')
y <- as.quantity (12, 'time$hour')
qSum (x,y)       # returns 2,5 days
qSum (y,x)       # returns 60 hours
qSum (x,y, unit='time$week')
x <- as.quantity (c(1,2,3), 'time$day')
qMax (x,y)       # returns 3 days
x <- as.quantity (c(1,2,3), 'time$day')
qMin (x,y)       # returns 1 day
x <- as.quantity (2, 'time$second')
qInv (x)      # returns 0.5 second⁻¹
x <- as.quantity (2, 'time$day')
y <- as.quantity (12, 'time$hour')
qProd (x, y)      # returns 1 day²
qProd (y, x)      # returns 576 hours²
x <- as.quantity (2, 'time$day')
y <- as.quantity (12, 'time$hour')
qDiv (x,y)       # returns 4
qDiv (y,x)       # returns .25
x <- as.quantity (2, 'time$day')
y <- as.quantity (12, 'time$hour')
sameQdim (x,y)       # returns TRUE
x <- as.quantity (2, 'time$day')
y <- as.quantity (12, 'time$hour')
qUnlist (list (x, NULL, y)) # returns as.quantity (c(2, .5), time$day)

Pisca46/quantities documentation built on May 31, 2019, 11:41 p.m.