unitted_Ops: Operations on unitbundles

In appling/unitted: Track Units as you Manipulate Data

Description

When data with units are combined by arithmetic, comparative, or logical operations, the units ought to be propagated through according to standard rules. Data that are unitted obey these rules because the methods that handle operations on unitted objects are specially designed to do so.

To ensure that unit checking happens in as many arithmetic operations as possible, even with funny combinations of unitted and non-unitted objects, both S3 and S4 group generics are implemented for the unitted class.

unitted_Ops works behind the scenes to ensure that operations on unitted objects respect their units.

Usage

## S4 method for signature 'unitted,unitted'
Ops(e1, e2)

## S4 method for signature 'unitted,ANY'
Ops(e1, e2)

## S4 method for signature 'ANY,unitted'
Ops(e1, e2)

## S4 method for signature 'unitted,data.frame'
Ops(e1, e2)

## S4 method for signature 'data.frame,unitted'
Ops(e1, e2)

## S4 method for signature 'unitted,array'
Ops(e1, e2)

## S4 method for signature 'array,unitted'
Ops(e1, e2)

## S3 method for class 'unitted'
Ops(e1, e2)

unitted_Ops(.Generic, e1, e2)

## S4 method for signature 'ANY'
unitted_Ops(.Generic, e1, e2)

Arguments

e1	The first argument to a binary arithmetical operation, or the only argument to a unary operation
e2	The second argument to a binary arithmetical operation
.Generic	A generic function name, as for Ops.unitted and the S4 generic Ops

See Also

unitbundle for the unitbundle class; unitted for data with unitbundles attached

appling/unitted documentation built on May 10, 2019, 12:44 p.m.