Display evaluation results summary in Rmd

`print_eval_results` transforms the evaluation results from `evaluate_models()` for output in an R Markdown document.

print_eval_results(
  eval_results,
  test_set = FALSE,
  html = knitr::is_html_output(),
  digits = 2,
  sigfig = TRUE,
  na_disp = "NA",
  html_options = NULL,
  latex_options = NULL,
  fig_height = 6,
  fig_width = 10
)

Arguments

eval_results

Output of `evaluate_models()`

test_set

Logical indicating whether or not this evaluation is for the test set. If `FALSE`, output is assumed to be associated with validation set.

html

Logical indicating whether the output should be in html format. If FALSE, output is in latex format.

digits

Number of digits to display for numeric values

sigfig

Logical. If TRUE, digits refers to the number of significant figures. If FALSE, digits refers to the number of decimal places.

na_disp

Character string to display if NA entry is found in table.

html_options

List of additional named arguments to pass to pretty_DT().

latex_options

List of additional named arguments to pass to pretty_kable().

fig_height

Height of plot (in inches). See `fig.height` in the knitr chunk options.

fig_width

Width of plot (in inches). See `fig.width` in the knitr chunk options.

Value

Outputs html or latex text for the R Markdown document.