readScenario {irace}

Reads from a file the scenario settings to be used by irace.

Description

Reads from a file the scenario settings to be used by irace.

Usage

readScenario(filename = "", scenario = list(), params_def = .irace.params.def)

Arguments

filename

(character(1))
Filename from which the scenario will be read. If empty, the default scenarioFile is used. An example scenario file is provided in ⁠system.file(``package="irace",⁠ ⁠"templates/scenario.txt.tmpl")⁠.

scenario

(list())
Data structure containing irace settings. The data structure has to be the one returned by the function defaultScenario() or readScenario(). This is an initial scenario that is overwritten

params_def

(data.frame())
Definition of the options accepted by the scenario. This should only be modified by packages that wish to extend irace.

Value

The scenario list read from the file. The scenario settings not present in the file are not present in the list, i.e., they are NULL.

Author(s)

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

See Also

printScenario()

prints the given scenario.

defaultScenario()

returns the default scenario settings of irace.

checkScenario()

to check that the scenario is valid.