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/Rtmp298XUw/file1d6a8aaa120/report.html'.
#>
#>
#> processing file: report_html.Rmd
#>
|
| | 0%
|
|. | 2%
|
|. | 4% (unnamed-chunk-1)
|
|.. | 6%
|
|... | 8% (unnamed-chunk-2)
|
|... | 10%
|
|.... | 12% (setup)
|
|..... | 15%
|
|...... | 17% (unnamed-chunk-3)
|
|...... | 19%
|
|....... | 21% (parameters_summarise)
|
|........ | 23%
|
|........ | 25% (parameters_tree)
|
|......... | 27%
|
|.......... | 29% (printParameters)
|
|.......... | 31%
|
|........... | 33% (table-by-iterations)
|
|............ | 35%
|
|............ | 38% (table-by-instance)
|
|............. | 40%
|
|.............. | 42% (table-elite)
|
|.............. | 44%
|
|............... | 46% (parcoords-elites)
|
|................ | 48%
|
|................ | 50% (fig-sampling-model)
|
|................. | 52%
|
|.................. | 54% (unnamed-chunk-4)
|
|................... | 56%
|
|................... | 58% (boxplot-test-elites-rpd)
|
|.................... | 60% (boxplot-test-elites-raw)
|
|..................... | 62%
|
|..................... | 65% (boxplot-test-iteration-elites-rpd)
|
|...................... | 67%
|
|....................... | 69% (table-train-elites)
|
|....................... | 71%
|
|........................ | 73% (boxplot-train-elite-rpd)
|
|......................... | 75% (boxplot-train-elite-raw)
|
|......................... | 77%
|
|.......................... | 79% (unnamed-chunk-5)
|
|........................... | 81% (boxplot-train-iteration-elites-rpd)
|
|............................ | 83% (boxplot-train-iteration-elites-raw)
|
|............................ | 85%
|
|............................. | 88% (experiments-matrix)
|
|.............................. | 90%
|
|.............................. | 92% (unnamed-chunk-6)
|
|............................... | 94%
|
|................................ | 96% (configurations-display)
|
|................................ | 98%
|
|.................................| 100% (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/Rtmp298XUw/file1d6a8aaa120/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/Rtmp298XUw/rmarkdown-str1d6a5d146b2e.html
#>
#> Output created: report.html
#> [1] "/tmp/Rtmp298XUw/file1d6a8aaa120/report.html"
# }