| simResult-class {portfolioSim} | R Documentation |
The highest level object that contains simulation result data.
Objects can be created by calls of the form new("simResult", ...).
freq:"numeric" that specifies
the frequency of periods in the simulation with respect to a
year. A value of 1 indicates annual periods, 12 monthly periods, etc.data:"list" that contains
singlePeriodResult objects for each period.errors:"list" that contains a
record of any errors caught during the processing of each period.type:"character" that
specifies the type of data contained in this object. Usually
pertains to partial saving of period and instant information.summary.interface:"simSummaryInterfaceOrNull" that can be used as an
additional saving filter for single-period results.signature(object = "simResult", in.loc =
"character", fmt = "missing"): load in the simulation data
stored in in.loc. Currently only one format, binary
.RData, is available, and so the fmt parameter is missing
here.
signature(x = "simResult", y = "missing"): plot
simulation results.signature(object = "simResult", type =
"missing", fmt = "missing", out.loc = "character", name =
"missing", verbose = "logical"): save this object. Currently
only one format, binary .RData, is available, and so the
fmt parameter is missing here. signature(object = "simResult"): summarize
the simulation.Jeff Enos jeff@kanecap.com