# Iterated Racing for Automatic Algorithm Configuration

## Documentation for package ‘irace’ version 4.4.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

irace-package | The irace package: Iterated Racing for Automatic Algorithm Configuration
ablation | Performs ablation between two configurations (from source to target).
ablation_cmdline | Launch ablation with command-line options.
buildCommandLine | Generate a command-line representation of a configuration
checkIraceScenario | Test that the given irace scenario can be run.
checkParameters | checkParameters
checkScenario | Check and correct the given scenario
check_output_target_runner | Check the output of the target runner and repair it if possible. If the output is incorrect, this function will throw an error.
configurations_print | Print configurations as a data frame
configurations_print_command | Print configurations as command-line strings.
defaultScenario | Default scenario settings
getConfigurationById | Returns the configurations selected by ID.
getConfigurationByIteration | Returns the configurations by the iteration in which they were executed.
getFinalElites | Return the elite configurations of the final iteration.
get_instanceID_seed_pairs | Returns the pairs of instance IDs and seeds used as instances in the race (and optionally the actual instances).
get_random_seed | Get, set and restore the state of the random number generator state.
has_testing_data | Check if the results object generated by irace has data about the testing phase.
irace | Execute one run of the Iterated Racing algorithm.
irace.cmdline | Launch 'irace' with command-line options.
irace_cmdline | Launch 'irace' with command-line options.
irace_license | irace_license
irace_main | Higher-level interface to launch irace.
irace_summarise | Summarise the results of a run of irace
irace_version | A character string containing the version of 'irace' including git SHA.
multi_irace | Execute 'irace()' multiple times with the same or different scenarios and parameter space definitions.
parameters | Create a parameter space to be tuned.
parametersNew | Create a parameter space to be tuned.
param_cat | Create a parameter space to be tuned.
param_int | Create a parameter space to be tuned.
param_ord | Create a parameter space to be tuned.
param_real | Create a parameter space to be tuned.
path_rel2abs | Converts a relative path to an absolute path.
plotAblation | Create plot from an ablation log
printParameters | Print parameter space in the textual format accepted by irace.
printScenario | Prints the given scenario
psRace | Post-selection race
random_seed | Get, set and restore the state of the random number generator state.
readConfigurationsFile | Read parameter configurations from a file
readParameters | Reads the parameters to be tuned by 'irace' from a file or from a character string.
readScenario | Reads from a file the scenario settings to be used by 'irace'.
read_ablogfile | Read the log file ('log-ablation.Rdata') produced by 'ablation()'.
read_logfile | Read the log file produced by irace ('irace.Rdata').
read_pcs_file | Read parameters in PCS (AClib) format and write them in irace format.
removeConfigurationsMetaData | removeConfigurationsMetaData
restore_random_seed | Get, set and restore the state of the random number generator state.
save_irace_logfile | Save the log generated by 'irace' to a file (by default 'irace.Rdata').
scenario_update_paths | Update filesystem paths of a scenario consistently.
set_random_seed | Get, set and restore the state of the random number generator state.
target_evaluator_default | target_evaluator_default
target_runner_default | Default 'targetRunner' function.
testConfigurations | Execute the given configurations on the testing instances specified in the scenario
testing_fromfile | Test configurations given an explicit table of configurations and a scenario file
testing_fromlog | Test configurations given in the logfile (typically 'irace.Rdata') produced by 'irace'.