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
report(
irace_results,
filename = "report",
sections = list(experiments_matrix = NULL, convergence = FALSE),
interactive = base::interactive()
)The data generated when loading the .Rdata file created by irace (or the filename of that file).
(character(1))
Filename indicating where to save the report (example: "~/path-to/filename").
(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.
(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(),
filename where the report was created or it opens the report in the default browser (interactive).
# \donttest{
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())
#> ℹ Creating file '/tmp/Rtmp4Fj0c3/file2f2a6ac872c8/report.html'.
#>
#>
#> processing file: report_html.Rmd
#> 1/49
#> 2/49 [unnamed-chunk-1]
#> 3/49
#> 4/49 [unnamed-chunk-2]
#> 5/49
#> 6/49 [setup]
#> 7/49
#> 8/49 [unnamed-chunk-3]
#> 9/49
#> 10/49 [parameters_summarise]
#> 11/49
#> 12/49 [parameters_tree]
#> 13/49
#> 14/49 [printParameters]
#> 15/49
#> 16/49 [table-by-iterations]
#> 17/49
#> 18/49 [table-by-instance]
#> 19/49
#> 20/49 [table-elite]
#> 21/49
#> 22/49 [parcoords-elites]
#> 23/49
#> 24/49 [fig-sampling-model]
#> 25/49
#> 26/49 [unnamed-chunk-4]
#> 27/49
#> 28/49 [boxplot-test-elites-rpd]
#> 29/49 [boxplot-test-elites-raw]
#> 30/49
#> 31/49 [boxplot-test-iteration-elites-rpd]
#> 32/49
#> 33/49 [table-train-elites]
#> 34/49
#> 35/49 [boxplot-train-elite-rpd]
#> 36/49 [boxplot-train-elite-raw]
#> 37/49
#> 38/49 [unnamed-chunk-5]
#> 39/49 [boxplot-train-iteration-elites-rpd]
#> 40/49 [boxplot-train-iteration-elites-raw]
#> 41/49
#> 42/49 [experiments-matrix]
#> 43/49
#> 44/49 [unnamed-chunk-6]
#> 45/49
#> 46/49 [configurations-display]
#> 47/49
#> 48/49 [unnamed-chunk-7]
#> 49/49
#> output file: report_html.knit.md
#> /opt/hostedtoolcache/pandoc/3.1.11/x64/pandoc +RTS -K512m -RTS report_html.knit.md --to html4 --from markdown+autolink_bare_uris+tex_math_single_backslash --output /tmp/Rtmp4Fj0c3/file2f2a6ac872c8/report.html --lua-filter /home/runner/work/_temp/Library/rmarkdown/rmarkdown/lua/pagebreak.lua --lua-filter /home/runner/work/_temp/Library/rmarkdown/rmarkdown/lua/latex-div.lua --embed-resources --standalone --variable bs3=TRUE --section-divs --table-of-contents --toc-depth 3 --variable toc_float=1 --variable toc_selectors=h1,h2,h3 --variable toc_collapsed=1 --variable toc_smooth_scroll=1 --variable toc_print=1 --template /home/runner/work/_temp/Library/rmarkdown/rmd/h/default.html --highlight-style pygments --variable theme=bootstrap --mathjax --variable 'mathjax-url=https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML' --include-in-header /tmp/Rtmp4Fj0c3/rmarkdown-str2f2a5e01417c.html
#>
#> Output created: report.html
#> [1] "/tmp/Rtmp4Fj0c3/file2f2a6ac872c8/report.html"
# }