tornadounc: Computes Correlation Between Inputs and Output in the...

In mc2d: Tools for Two-Dimensional Monte-Carlo Simulations

Computes Correlation Between Inputs and Output in the Uncertainty Dimension (Tornado)

Description

Provides statistics for a tornado chart. Evaluates correlations between output and inputs of a ‘⁠mc⁠’ object in the uncertainty dimension.

Usage

tornadounc(mc, ...)

## Default S3 method:
tornadounc(mc, ...)

## S3 method for class 'mc'
tornadounc(
  mc,
  output = length(mc),
  quant = c(0.5, 0.75, 0.975),
  use = "all.obs",
  method = c("spearman", "kendall", "pearson"),
  ...
)

## S3 method for class 'tornadounc'
print(x, ...)

## S3 method for class 'mccut'
tornadounc(
  mc,
  output = length(mc),
  quant = c(0.5, 0.75, 0.975),
  use = "all.obs",
  method = c("spearman", "kendall", "pearson"),
  ...
)

Arguments

mc	a ‘⁠mc⁠’ object.
...	further arguments to be passed to the final print function.
output	the rank or name of the output. Should be a ‘⁠"VU"⁠’ or ‘⁠"U"⁠’ node. By default: the last element.
quant	the vector of quantiles used in the variability dimension.
use	an optional character string for computing covariances in presence of missing values: ‘⁠"all.obs"⁠’, ‘⁠"complete.obs"⁠’ or ‘⁠"pairwise.complete.obs"⁠’.
method	a character string for the correlation coefficient: ‘⁠"spearman"⁠’ (default), ‘⁠"kendall"⁠’ or ‘⁠"pearson"⁠’.
x	a ‘⁠tornadounc⁠’ object.

Details

The function computes Spearman's rho statistic between values or statistics calculated in the variability dimension of inputs and outputs. The statistics are the mean, the standard deviation and the quantiles specified by ‘⁠quant⁠’.

‘⁠tornadounc.mccut⁠’ may be applied on a mccut object if a ‘⁠summary.mc⁠’ function was used in the third block of the evalmccut call.

Value

an invisible object of class ‘⁠tornadounc⁠’.

See Also

cor, tornado for variability dimension, plot.tornadounc to draw the results.

Examples

data(total)
tornadounc(total, 3)
(y <- tornadounc(total, 10, use="complete.obs"))
plot(y, 1, 1)

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