getDistOfValuesByYear: Get the Distribution of Value by Year

In rexmacey/aasim: Asset Allocation Simulation

Get the Distribution of Value by Year

Description

For each year (1 to maximum length of a trail), it returns the number of trials of that length (nTrials) and the quantiles associated with the probs.

Usage

getDistOfValuesByYear(
  sim,
  probs = c(0, 0.05, 0.25, 0.5, 0.75, 0.95, 1),
  simResult = "simulation",
  inflationAdjusted = TRUE
)

Arguments

sim	Simulation object after running simulate function
probs	numeric vector of probabilities with values [0-1]. The default is c(0.0, 0.05, 0.25, 0.50, 0.75, 0.95, 1.0).
simResult	Name of item in sim with results (class = 'simResult')
inflationAdjusted	TRUE to adjust portfolio values by inflation, otherwise FALSE.

Value

data frame

Examples

## Not run: getDistOfValuesByYear(sim)

rexmacey/aasim documentation built on Oct. 29, 2024, 9:30 a.m.