metRology (version 0.9-28-1)

uncert-class: The 'uncert' class

Description

Object returned by uncert calls.

Usage

# S3 method for uncert
print(x, digits=NULL, right=FALSE, …, simplify=TRUE)
   # S3 method for uncert
summary(object, …, simplify=TRUE)

Arguments

x, object

An object of class uncert

digits

Number of digits to display in budget and (if present) distribution parameter lists. Passed to format for distribution parameter list and to print.data.frame for output.

right

If TRUE, strings in uncertainty budget are right-justified. This differs from the default in print.data.frame.

…

Other parameters passed to print.data.frame

simplify

If TRUE, only the call, evaluation method, budget, value y and combined uncertainty (u.y) are printed.

Value

print and summary methods invisibly return the original object.

Methods

print

The print method provides a formatted printout of the object. By default, simplify=TRUE; this displays a shortened listing. Columns in $budget are suppressed if all NA (typically df when not specified).

summary

summary is currently an alias for the print method.

Details

summary.uncert simply calls print.uncert.

An object of class "uncert" contains:

call

The matched call

y

The calculated value (for function, expression or formula methods) or NA

u.y

The combined standard uncertainty

method

The uncertainty evaluation method used.

budget

A data frame consisting of:

x

x (if supplied; otherwise a vector of NA's).

u

The standard uncertainties in input quantities (originally provided as u)

df

The degrees of freedom asscociated with u

c

Sensitivity coefficients either provided as c or (for the formula, function and expression methods) as calculated.

u.c

The product of u and c. These are the contributions to the combined uncertainty for uncorrelated quantities.

additional

Any relevant parameters other than those in $budget$x (typically addditional constants passed to function or expression methods)

distrib

If available, a named list of the distributions associated with u. The list contains either root nams of distribution functions (e.g "norm" or function definitions.

distrib.pars

If available, a list of lists of parameters describing the distributions associated with u.

cov

The covariance matrix used

cor

The correlation matrix used

cov.xy

A data frame of covariances between x and y. Row names correspond to the correlation method used. For all uncertainty evaluation methods but MC, the only correlation calculation is "theoretical"; for MC row names include all methods supported by stats::cor at the time the object was created.

cor.xy

A data frame of correlations between x and y, of the same form as cov.xy

deriv

For the formula and expression methods, the result of a call to deriv; an expression which evaluates to the value with attributes corresponding to the derivatives (that is, an expression which can be evaluated to give the value and sensitivity coefficients)

References

None.

See Also

uncert, especially for calculation methods; plot.uncert, uncertMC-class, print.data.frame, format.

Examples

# NOT RUN {
  expr <- expression(a+b*2+c*3+d/2)
  x <- list(a=1, b=3, c=2, d=11)
  u <- lapply(x, function(x) x/10)
  u.expr<-uncert(expr, x, u, method="NUM")
  print(u.expr)

# }