Generate an HTML report for an energyRt object

Thin wrapper around report that fixes format = "html". Produces a portable single-file .html document with embedded assets.

Usage

report_html(object, ...)

# S4 method for class 'ANY'
report_html(object, ...)

Arguments

object: An energyRt S4 object: technology, repository, model, or solved scenario.
...: Arguments forwarded to levcost (when levcost = NULL and levcost parameters are provided) and/or to rmarkdown::render(). Known levcost parameter names are intercepted automatically; everything else is passed to the renderer. For a whole-scenario report, levcost = TRUE adds an ex-post levelized-cost table via levcost(scenario).

Value

Path to the generated .html file (invisibly).

Examples

if (FALSE) { # \dontrun{
open_project(tempdir())
tech <- topia$modules$electricity$R3$ECOA

# a portable single-file page under the project's reports/
report_html(tech)

# a scenario's report covers results, where an object's covers assumptions
ek   <- topia$modules$electricity$R3
mod  <- newModel("TOPIA", data = ek$repo,
                 calendar = topia$modules$calendars$s4_h24,
                 region = ek$regions, horizon = topia$modules$horizons$base)
mod <- setGeoscale(mod, ek$geoscale)
scen <- solve_model(mod, name = "BASE", solver = solver_options$glpk)
report_html(scen)
} # }