Advanced user guide

Useful options

When making development with sstCalculation, we recommend to have a look at these options:

# Override the configuration table from the SST-Template to use the latest version.
options(sstCalculation.pathConfiguration = "inst/extdata/wb.csv")
# The debug mode is per default set to FALSE in order to capture all error message before they are thrown to the user
# If you need to debug the R-Tool, please set this option to TRUE
options(sstCalculation.debugMode = FALSE)
# This option stores a local copy of the templates loaded. This makes it much faster to load the same template a second time.
# This is in particular useful when variants are used, as the same template is loaded several times
# Please ensure that the corresponding directory exists
options(sstCalculation.pathCache = "~/cache/")

When using the option sstCalculation.pathCache, please ensure that you understand the consequences this option. For security reasons, you may not want to keep a copy of all inputs processed locally on your computer.

How to change the configuration of the SST-Template

The SST Template contains in the last worksheet Configuration all inputs required to parse the template and to produce the FDS. This worksheet contains the content of the following two files:

• wb.csv for the parser configuration
• wbFDS for the FDS configuration

To edit the configuration, you need to proceed as follow: * Edit zConfigurationFDS.R and zConfigurationParser.R and execute the corresponding functions. * Integrate the csv files in the SST-Template for example with copy-paste (or use sstCalculation.pathConfiguration if you edited only wb.csv)

How to load mulitple templates

This experimental feature is not compatible with the use of the participation template.

The SST-Template can be loaded jointly with another template. It is considered by the R-Tool as if it was only one large template having all worksheets from both templates. If a worksheet with the same name is in Template and in Config, then the one in Config is used.

path <- list(Template = "~/SST Template.xlsx", Config = "~/AdditionalTemplate.xlsx")
results <- sstCalculation(path, nsim = 100000, seed = 1)

Reset the default options

To reset the default options, you can run this code

options(sstCalculation.pathConfiguration = "inst/extdata/wb.csv")
options(sstCalculation.debugMode = FALSE)
options(sstCalculation.pathCache = NULL)