getGrowth1Dollar: Growth of $1

View source: R/analyzeSim.r

getGrowth1DollarR Documentation

Growth of $1

Description

Calculates the growth of $1 from the rates of returns in the trials specified by idxVec.

Usage

getGrowth1Dollar(sim, simResult, idxVec)

Arguments

sim

Simulation object.

simResult

Name of item in sim with results (class = 'simResult')

idxVec

Vector of one or more indices representing a trial.

Value

Data frame. The number of row will be one more than the longest length of the trials. The first column is the year and each subsequent column is the growth of $1 for each element in idxVec.

Examples

## Not run: getGrowth1Dollar(sim, simResult, c(1, 2, 3))

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