SensitivityAnalysis | R Documentation |
Supports Sensitivity Analysis workflow to assess the impact of input parameters on the simulation outputs
rSharp::NetObject
-> ospsuite::DotNetWrapper
-> SensitivityAnalysis
simulation
Reference to the Simulation
used to calculate or import the sensitivity analysis results (Read-Only).
numberOfSteps
Number of steps used for the variation of each parameter (optional, default specified in ospsuiteEnv$sensitivityAnalysisConfig
)
variationRange
Variation applied to the parameter (optional, default specified in ospsuiteEnv$sensitivityAnalysisConfig
)
parameterPaths
List of parameters to use for sensitivity calculation.If empty, the sensitivity will be performed automatically on all constant parameters that are really in use in the simulation. Constant parameter means all parameters with a constant value or a formula parameter with a value that was overridden by the user
rSharp::NetObject$call()
rSharp::NetObject$finalize()
rSharp::NetObject$get()
rSharp::NetObject$getFields()
rSharp::NetObject$getMemberSignature()
rSharp::NetObject$getMethods()
rSharp::NetObject$getProperties()
rSharp::NetObject$getStaticFields()
rSharp::NetObject$getStaticMethods()
rSharp::NetObject$getStaticProperties()
rSharp::NetObject$set()
new()
Initialize a new instance of the class
SensitivityAnalysis$new( simulation, parameterPaths = NULL, numberOfSteps = ospsuiteEnv$sensitivityAnalysisConfig$numberOfSteps, variationRange = ospsuiteEnv$sensitivityAnalysisConfig$variationRange )
simulation
Simulation for which a sensitivity analysis should be performed
parameterPaths
Vector of parameter paths to use for sensitivity calculation (optional).If undefined, the sensitivity will be performed automatically on all constant parameters of the simulation. Constant parameter means all parameters with a constant value or a formula parameter with a value that was overridden by the user
numberOfSteps
Number of steps used for the variation of each parameter (optional, default specified in getOSPSuiteSetting("sensitivityAnalysisConfig")
)
variationRange
Variation applied to the parameter (optional, default specified in getOSPSuiteSetting("sensitivityAnalysisConfig")
)
A new SensitivityAnalysis
object.
addParameterPaths()
Adds the parameterPaths to the list of parameter path to vary in the sensitivity analysis
SensitivityAnalysis$addParameterPaths(parameterPaths)
parameterPaths
Parameter paths to add (single or multiple values)
If no parameters were specified during creating of a SensitivityAnalysis
(all constant parameters are considered),
calling addParameterPaths
will make only the manually added parameters being varied.
clearParameterPaths()
Removes all parameter paths defined in the Sensitivity Analysis
SensitivityAnalysis$clearParameterPaths()
print()
Print the object to the console
SensitivityAnalysis$print(...)
...
Rest arguments.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.