checkScenario: Check and correct the given scenario

View source: R/readConfiguration.R

checkScenarioR Documentation

Check and correct the given scenario

Description

Checks for errors a (possibly incomplete) scenario setup of irace and transforms it into a valid scenario.

Usage

checkScenario(scenario = defaultScenario())

Arguments

scenario

(list())
Data structure containing irace settings. The data structure has to be the one returned by the function defaultScenario() or readScenario().

Details

This function checks that the directories and the file names provided and required by the irace exist. It also checks that the settings are of the proper type, e.g. that settings expected to be integers are really integers. Finally, it also checks that there is no inconsistency between settings. If an error is found that prevents irace from running properly, it will stop with an error.

Value

The scenario received as a parameter, possibly corrected. Unset scenario settings are set to their default values.

Author(s)

Manuel López-Ibáñez and Jérémie Dubois-Lacoste

See Also

readScenario()

for reading a configuration scenario from a file.

printScenario()

prints the given scenario.

defaultScenario()

returns the default scenario settings of irace.

checkScenario()

to check that the scenario is valid.


irace documentation built on Oct. 23, 2022, 5:06 p.m.