getSimSummary: Produces a summary object containing the metadata of a full...

getSimSummaryR Documentation

Produces a summary object containing the metadata of a full simulation

Description

getSimSummary uses a full simulation generated using the function generateScenarios as input and outputs a summary object containing the metadata of the full simulation. The output summary object may be used as an input to the plotting functions in this package. The output summary object will be much smaller in size than the full simulation for ease of storage and use with the plotting functions.

Usage

getSimSummary(sim)

Arguments

sim

list; a simulation containing the scenarios generated using the function generateScenarios.

See Also

generateScenarios, plotPerformanceSpace, plotPerformanceOAT


foreSIGHT documentation built on Oct. 19, 2023, 9:08 a.m.