build_dashboard: Create IPCA forecast model dashboard

In schoulten/ipca: Brazilian Inflation Forecasting Model

Create IPCA forecast model dashboard

Description

Create IPCA forecast model dashboard

Usage

build_dashboard(
  y = "ipca",
  data = ts_transform(get_data(), y),
  accuracy = train_models(data, y),
  forecast = forecast_ensemble(ts_transform(get_data(), y, seasonal_dummies = FALSE),
    y),
  ensemble_col = "ensemble",
  title_fanchart = rlang::as_utf8_character("**Fanchart**: Previsão do IPCA"),
  y_lab_fanchart = "% a.m.",
  caption_lab = rlang::as_utf8_character("**Elaboração:** analisemacro.com.br"),
  title_accuracy = rlang::as_utf8_character("**Acurácia**: performance por horizonte"),
  subtitle_accuracy = rlang::as_utf8_character("Modelos de previsão do IPCA"),
  x_lab_accuracy = "Horizonte (meses)",
  save_at = "docs"
)

Arguments

y	Column name of the variable of interest
data	A tsibble object, similar to the output of ts_transform(get_data(), y)
accuracy	A tibble object, similar and with the same column names as the output of train_models
forecast	A tsibble object, similar to the output of forecast_ensemble
ensemble_col	Column name of ensemble forecasts in forecast
title_fanchart	Title for the forecast fanchart
y_lab_fanchart	Fanchart Y-axis title
caption_lab	Text for caption
title_accuracy	Title for predictive horizon accuracy graph (accuracy data)
subtitle_accuracy	Subtitle for the accuracy graph by predictive horizon (accuracy data)
x_lab_accuracy	X-axis text in accuracy graph by predictive horizon (accuracy data)
save_at	Directory name to save the HTML file, if it does not exist it will be created

Value

Flexdashboard HTML file named as index.html.

Examples

td <- tempdir()
build_dashboard(save_at = td)

schoulten/ipca documentation built on May 27, 2022, 10:05 p.m.