chartSampleTrialsPortfolioValues: Chart a Sample of the Trials (Wealth Over Time) Given a...

In rexmacey/aasim: Asset Allocation Simulation

Chart a Sample of the Trials (Wealth Over Time) Given a Vector of Indices

Description

This will produce a chart with a length(sampleIndex) number of lines representing individual trials. The sampleIndex is a vector with the numbers of the trials to display. For example, to plot the first hundred trials, sampleIndex would equal 1:100.

Usage

chartSampleTrialsPortfolioValues(
  sim,
  sampleIndex,
  logScale = FALSE,
  simResult = "simulation",
  inflationAdjusted = FALSE
)

Arguments

sim	Simulation object
sampleIndex	Vector of indices of the trials to plot.
logScale	True to display the y-axis in log format
simResult	Name of item in sim with results (class = 'simResult')
inflationAdjusted	TRUE to adjust portfolio values by inflation, otherwise FALSE.

Value

Chart object (plotly)

Examples

## Not run: chartSampleTrialsPortfolioValues(sim, sampleIndex, logScale)

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