fastester.display
Generate html documents with charts and tables, communicating objective performance changes across versions.
See fastester.measure for utilities to run the benchmarks and save the performance data.
default-chart-style
A hashmap containing clj-xchart chart options, governing theme, legend position, plot border, etc.
generate-documents
(generate-documents & [explicit-options-filename])Write-to-file html and markdown documents that show performance measurements across a library’s versions.
See fastester-defaults and Fastester project documentation for details on the structure of the options map.
generate-documents wholesale ingests all .edn data files in :results-directory. The :benchmarks option does not affect this document generation step. Make sure every .edn in the results directory represents data intended to be displayed in the document. Errant data files produce confusing charts and tables.
Similarly, generate-documents consumes all svg files in :img-subdirectory. If a project’s benchmarks are split among multiple files/namespaces, be sure to give each file/namespace its own dedicated image subdirectory with the :img-subdirectory option. Otherwise, one namespace’s svg files will be inserted into another’s html document.