report {iraceplot}

Create HTML Report from irace data

Description

This function creates an HTML report of the most relevant irace data. This report provides general statistics and plots that show the best configurations and their performance. Example: https://auto-optimization.github.io/iraceplot/articles/example/report_example.html

Usage

report(
  irace_results,
  filename = "report",
  sections = list(experiments_matrix = NULL, convergence = FALSE),
  interactive = base::interactive()
)

Arguments

irace_results

The data generated when loading the .Rdata file created by irace (or the filename of that file).

filename

(character(1)) Filename indicating where to save the report (example: "~/path-to/filename").

sections

(list()) List of sections to enable/disable. This is useful for disabling sections that may cause problems, such as out-of-memory errors. NA means automatically enable/disable a section depending on the memory required.

interactive

(logical(1)) TRUE if the report may use interactive features (using plotly::ggplotly(), plotly::plot_ly() and DT::renderDataTable()) or FALSE if such features must be disabled. Defaults to the value returned by interactive(),

Value

filename where the report was created or it opens the report in the default browser (interactive).

Examples

 
 withr::with_tempdir({
   iraceResults <- read_logfile(system.file(package="irace", "exdata",
                                            "irace-acotsp.Rdata", mustWork = TRUE))
   report(iraceResults, filename = file.path(getwd(), "report"))
 }, clean = !base::interactive())