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/RtmpKnwlfm/file1e6922ede6f8/report.html'.
#>
#>
#> processing file: report_html.Rmd
#> 1/48
#> 2/48 [unnamed-chunk-1]
#> 3/48
#> 4/48 [unnamed-chunk-2]
#> 5/48
#> 6/48 [setup]
#> 7/48
#> 8/48 [unnamed-chunk-3]
#> 9/48
#> 10/48 [parameters_summarise]
#> 11/48
#> 12/48 [parameters_tree]
#> 13/48
#> 14/48 [printParameters]
#> 15/48
#> 16/48 [table-by-iterations]
#> 17/48
#> 18/48 [table-by-instance]
#> 19/48
#> 20/48 [table-elite]
#> 21/48
#> 22/48 [parcoords-elites]
#> 23/48
#> 24/48 [fig-sampling-model]
#> 25/48
#> 26/48 [unnamed-chunk-4]
#> 27/48
#> 28/48 [boxplot-test-elites-rpd]
#> 29/48 [boxplot-test-elites-raw]
#> 30/48
#> 31/48 [boxplot-test-iteration-elites-rpd]
#> 32/48
#> 33/48 [table-train-elites]
#> 34/48
#> 35/48 [boxplot-train-elite-rpd]
#> 36/48 [boxplot-train-elite-raw]
#> 37/48
#> 38/48 [unnamed-chunk-5]
#> 39/48 [boxplot-train-iteration-elites-rpd]
#> 40/48 [boxplot-train-iteration-elites-raw]
#> 41/48
#> 42/48 [experiments-matrix]
#> 43/48
#> 44/48 [unnamed-chunk-6]
#> 45/48
#> 46/48 [configurations-display]
#> 47/48
#> 48/48 [unnamed-chunk-7]
#> output file: report_html.knit.md
#> /usr/bin/pandoc +RTS -K512m -RTS report_html.knit.md --to html4 --from markdown+autolink_bare_uris+tex_math_single_backslash --output /tmp/RtmpKnwlfm/file1e6922ede6f8/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/RtmpKnwlfm/rmarkdown-str1e697c64992e.html
#>
#> Output created: report.html
#> [1] "/tmp/RtmpKnwlfm/file1e6922ede6f8/report.html"
# }