getSuccessStats: Get Success Statistics

In rexmacey/aasim: Asset Allocation Simulation

Get Success Statistics

Description

Success vs target is defined as a trial with a terminal value >= the terminal value. Success vs zero (0) is defined as a trial with a terminal value > 0. The list returned by this function includes: vector of success by trial vs target, vector of success by trial vs 0, integer count of success vs target, integet count of success vs 0, numeric percentage success vs target numeric percentage success vs 0

Usage

getSuccessStats(sim, simResult = "simulation")

Arguments

sim	Simulation object after running simulate function
simResult	Name of item in sim with results (class = 'simResult')

Value

list

Examples

## Not run: getSuccessStats(sim)

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