groupGeneric.ValueWithUncertainty: Ops Value with Uncertainty

In micko920/ValueWithUncertainty: Value with associated uncertainty represented by Upper and Lower CI

Ops Value with Uncertainty

Description

Ops

Summary of Value with Uncertainty Export Functions

Usage

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

## S3 method for class 'ValueWithUncertainty'
Summary(..., na.rm = FALSE)

Arguments

e1	Parameter definition tbc
e2	Parameter definition tbc

Details

Ops

Boolean operators drop the uncertainty (showing a warning once) and operate on the numeric values. Any ValueWithUncertainty operand is automatically coerced to numeric with no uncertainty.

Summary

The methods all and any are not supported for ValueWithUncertainty objects and fail with an informative message. min, max (and range) return the minimum or (and) maximum of the CI

Value

tbc output from function

References

TBC

TBC

Examples

y <- ValueWithUncertainty(1, 10, 100)
x / sqrt(y) + y * sin(x)

# numeric values automatically coerced this type to numeric and drop
# uncertainty
x^2

# boolean operators drop uncertainty
y > x
c(min(x), max(x))
range(x)
sum(y)
prod(y)

micko920/ValueWithUncertainty documentation built on Aug. 1, 2024, 9:33 a.m.