summary.SWIM {SWIM} | R Documentation |
Summarising Stressed Models
Description
This function is a methods
for an object of class
SWIM
or SWIMw
. Provides summary statistics of the stochastic model,
stressed using the scenario weights.
Usage
## S3 method for class 'SWIM'
summary(object, ..., xCol = "all", wCol = "all", base = FALSE)
## S3 method for class 'SWIMw'
summary(object, ..., xCol = "all", wCol = "all", base = FALSE)
Arguments
object |
A |
... |
Additional arguments will be ignored. |
xCol |
Numeric or character vector, (names of) the columns of
the underlying data
of the |
wCol |
Vector, the columns of the scenario weights
of the |
base |
Logical, if |
Value
summary.SWIM
returns a list with components
corresponding to different stresses. Components contain a
summary statistic of each column of the data of the
SWIM
object:
mean | The sample mean. |
sd | The sample standard deviation. |
skewness | The sample skewness. |
ex kurtosis | The sample excess kurtosis |
1st Qu. | The 25% quantile. |
Median | The median, 50% quantile. |
3rd Qu. | The 75% quantile. |
Functions
-
summary.SWIM
: Summarising Stressed Models -
summary.SWIMw
: Summarising Stressed Models
Author(s)
Silvana M. Pesenti
Zhuomin Mao
See Also
Examples
## Example with the Relative Entropy
## continuing example in stress_VaR
set.seed(0)
x <- as.data.frame(cbind(
"normal" = rnorm(1000),
"gamma" = rgamma(1000, shape = 2)))
res1 <- stress(type = "VaR", x = x,
alpha = 0.9, q_ratio = 1.05)
summary(res1, xCol = "normal", base = TRUE)
## Example with the Wasserstein distance
## Not run:
resW <- stress_wass(type = "RM", x = x,
alpha = 0.9, q_ratio = 1.05)
summary(resW, xCol = "normal", base = TRUE)
## End(Not run)