This function returns specified settings made by CB.BootstrapND or the Bootstrap tool.
Table 95. CB.GetBootstrapOption Parameters
Parameter | Required? | VBA Data Type | Table |
|---|---|---|---|
Index | Required | Integer | |
Index2 | Optional | Integer | |
Value | Optional | Variant |
Table 96. CB.GetBootstrapOption Index Parameter – Required, Integer
Named Constant Value | Index Value | Description |
|---|---|---|
cbBtsGetTarget | 1 | Returns a string with the address of the target forecast in the format: '[workbook]sheet'!$A$1 |
cbBtsGetDataRange | 2 | Returns a string with the address of the selected bootstrap data range in the format:'[workbook]sheet'!$A$1:$Z$100 |
cbBtsMethod | 3 | Returns the constant of the selected bootstrap method: cbBtsMethodResample [1] or cbBtsMethodMultiSim [2]. |
cbBtsAnalyze | 4 | Returns the constant of the selected analysis setting: cbBtsAnalyzeStat [1], cbBtsAnalyzePercent [2], or cbBtsAnalyzeCapMetrics [3]. |
cbBtsPercent | 5 | Returns the constant of the currently selected percentile setting (for use if cbBtsAnalyze is called with cbBtsAnalyzePercent [2]): cbBtsPercentTenNinety [1], cbBtsPercentFiveNinetyFive [2], cbBtsPercentQuartiles [3], cbBtsPercentQuintiles [4], cbBtsPercentDeciles [5], cbBtsPercentIcosatiles [6], or cbBtsPercentCustom [7]. If the returned value is cbBtsPercentCustom [7], you can use that constant as an Index2 parameter to return a range of custom values. |
cbBtsSample | 6 | Used with Index2 to return the current bootstrap sample settings for cbBtsNumberSamples [1] or cbBtsTrialsPerSample [2] |
cbBtsForeOption | 7 | Returns the constant of the current forecast display setting: cbBtsShowDefinedFore [1], cbBtsShowTargetFore [2], or cbBtsHideFore [3] |
Table 97. CB.GetBootstrapOption Index2 Parameter – Optional, Integer
Related Value | Named Constant Value | Index | Description |
|---|---|---|---|
For Index = 5, cbBtsPercent: Integer | cbBtsPercentCustom | 7 | Returns a range of custom percentile values in the range specified with Value |
For Index = 6, cbBtsSample: Integer | cbBtsNumberSamples | 1 | Used with cbBtsSample to return the number of bootstrap samples to use |
For Index = 6, cbBtsSample: Integer | cbBtsTrialsPerSample | 2 | Used with cbBtsSample to return the number of trials to run for each bootstrap sample |