getTerminalValues: Get Terminal Values of Each Trial
In rexmacey/aasim: Asset Allocation Simulation
getTerminalValues R Documentation
Get Terminal Values of Each Trial
Description
Returns a vector with a length equal to the number of trials containing the
year by year terminal values. This is useful for determining
success or failure.
Usage
getTerminalValues(sim, simResult = "simulation", inflationAdjusted = FALSE)
Arguments
sim
Simulation object after running simulate function
simResult
Name of item in sim with results (class = 'simResult')
inflationAdjusted
TRUE to adjust portfolio values by inflation, otherwise FALSE.
Value
vector of values
Examples
## Not run: getTerminalValues(sim)
rexmacey/aasim documentation built on Oct. 29, 2024, 9:30 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| getTerminalValues | R Documentation |
Get Terminal Values of Each Trial
Description
Returns a vector with a length equal to the number of trials containing the year by year terminal values. This is useful for determining success or failure.
Usage
getTerminalValues(sim, simResult = "simulation", inflationAdjusted = FALSE)
Arguments
sim |
Simulation object after running simulate function |
simResult |
Name of item in sim with results (class = 'simResult') |
inflationAdjusted |
TRUE to adjust portfolio values by inflation, otherwise FALSE. |
Value
vector of values
Examples
## Not run: getTerminalValues(sim)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.