summary.mc: Summary of mcnode and mc Object

View source: R/summary.mc.R

summary.mcR Documentation

Summary of mcnode and mc Object

Description

Provides a summary of a ‘⁠mcnode⁠’, a ‘⁠mc⁠’ or a ‘⁠mccut⁠’ object.

Usage

## S3 method for class 'mc'
summary(
  object,
  probs = c(0, 0.025, 0.25, 0.5, 0.75, 0.975, 1),
  lim = c(0.025, 0.975),
  ...
)

## S3 method for class 'mcnode'
summary(
  object,
  probs = c(0, 0.025, 0.25, 0.5, 0.75, 0.975, 1),
  lim = c(0.025, 0.975),
  digits = 3,
  ...
)

## S3 method for class 'summary.mc'
print(x, digits = 3, ...)

## S3 method for class 'mccut'
summary(object, lim = c(0.025, 0.975), ...)

Arguments

object

a ‘⁠mcnode⁠’, ‘⁠mc⁠’ or ‘⁠mccut⁠’ object.

probs

a vector of values used for the quantile function (variability dimension).

lim

a vector of values used for the quantile function (uncertainty dimension).

...

for generic function consistency.

digits

number of digits in the print.

x

a ‘⁠summary.mc⁠’ object as returned by the ‘⁠summary.mc⁠’ function.

Details

The mean, the standard deviation and the ‘⁠probs⁠’ quantiles will be evaluated in the variability dimension. The median, the mean and the ‘⁠lim⁠’ quantiles will then be evaluated on these statistics in the uncertainty dimension.

For multivariate nodes: if the ‘⁠"outm"⁠’ attribute is ‘⁠"none"⁠’, the node is not evaluated; if it is ‘⁠"each"⁠’, the variates are evaluated one by one; if it is a function name (e.g. ‘⁠"mean"⁠’), that function is applied on the variates dimension before output.

Value

a list.

See Also

mcnode for mcnode objects, mc for mc objects, mccut for mccut objects, quantile.

Examples

data(total)
summary(xVUM3)
summary(total)

mc2d documentation built on Oct. 23, 2026, 1:06 a.m.