standalone: Constructing a Standalone Market Risk

Description Usage Arguments Value Note See Also Examples

View source: R/standalone-base.R

Description

standalone Constructor for the S3 class standalone. A standalone market risk corresponds to a sub-model for market risk where only a subset of all market RiskFactors in a marketRisk is considered.

Usage

1
standalone(name, ..., list.arg = F)

Arguments

name

character value of length one representing the name of the standalone market risk. Please refer to the note Section to see which names cannot be used because there are reserved names for the model. Using such a name would trigger an error at the standalone construction.

...

S3 objects of class riskFactor.

list.arg

logical value of length one, by default set to FALSE. It allows to use ... argument to pass a list of objects of class riskFactor.

Value

a S3 object, instance of the class standalone.

Note

The following names are reserved for the model and cannot be used to name a standalone:

See Also

summary.standalone, print.standalone.

Examples

1
2
3
4
5
6
# Creating a new standalone.
standalone1 <- standalone(name = "CHF rates",
                          rate(name = "2YCHF", currency = "CHF", horizon = "k"),
                          rate(name = "10YCHF", currency = "CHF", horizon = "m"),
                          rate(name = "10YCHF", currency = "CHF", horizon = "l",
                          scale = 0.75))

sstModel documentation built on May 4, 2018, 1:04 a.m.