Description
Returns scenario information, indicating which inputs were instrumental in reaching a certain goal. See the @RISK for Excel User's Manual for more information about scenario analysis.
Syntax
object.Scenario(data() As RDKScenarioData, Optional targetMinPercentile as Double, Optional targetMaxPercentile as Double)
Arguments
data (Required Array of RDKScenarioData) - this variable receives an array of scenario information, which is sorted in order of descending importance. The array is automatically dimensioned from 1 to the number of inputs in the model. The RDKScenarioData type has the following definition:
| Public Type RDKScenarioData | |
| input As RDKInput | an input reference |
| significance As Double | ratio of subset median/original std dev |
| subsetMedian As Double | actual median of subset |
| subsetMedianPercentile As Double | percentile of median of subset of samples. |
| End Type |
targetMinPercentile (Optional Double) – The minimum percentile of the scenario subset. If not supplied, defaults to 0. If targetMinPercentile is not supplied, targetMaxPercentile must be supplied.
targetMaxPercentile (Optional Double) – The maximum percentile of the scenario subset. If not supplied, defaults to 1. If targetMaxPercentile is not supplied, targetMinPercentile must be supplied.
Return Value
None.
Example
'Retrieve scenario information for inputs that caused myOutput to fall in its 75th percentile:
Dim scData() as RDKScenarioData
RDKApp.Outputs("myOutput").Results.Scenario(scData, .75)