Plot a Forecast Object of the OSEM Model
plot.osem.forecast.Rd
Plot a Forecast Object of the OSEM Model
Usage
# S3 method for class 'osem.forecast'
plot(
x,
title = "OSEM Model Forecast",
exclude.exogenous = TRUE,
order.as.run = FALSE,
interactive = FALSE,
first_date = NULL,
grepl_variables = NULL,
return.data = FALSE,
...
)
Arguments
- x
An object of class osem.forecast, which is the output from the forecast_model function.
- title
Character. Title of the plot. Default is "OSEM Model Forecast".
- exclude.exogenous
Logical. Should exogenous values be plotted? Default is FALSE.
- order.as.run
Logical. Should the plots be arranged in the way that the model was run? Default FALSE.
- interactive
Logical. Should the resulting plot be launched in an interactive way (the plotly package is required for this).
- first_date
Character. First date value to be shown. Must be a character value that can be turned into a date using as.Date() or NULL.
- grepl_variables
Regular Expression Character. Can be used to select variables to be plotted. Experimental feature so use with care.
- return.data
Logical. Do not return a plot but rather just the final dataset that has been created for the plot.
- ...
Additional arguments passed to the plotting function.
Examples
spec <- dplyr::tibble(
type = c(
"d",
"d",
"n"
),
dependent = c(
"StatDiscrep",
"TOTS",
"Import"
),
independent = c(
"TOTS - FinConsExpHH - FinConsExpGov - GCapitalForm - Export",
"GValueAdd + Import",
"FinConsExpHH + GCapitalForm"
)
)
# \donttest{
a <- run_model(specification = spec, dictionary = NULL,
inputdata_directory = NULL, primary_source = "download",
save_to_disk = NULL, present = FALSE)
#> Dataset query already saved in cache_list.json...
#> Reading cache file /tmp/Rtmpb3d2BN/eurostat/19d1eb40c3b65782d7a4291ef4604d7e.rds
#> Table namq_10_a10 read from cache file: /tmp/Rtmpb3d2BN/eurostat/19d1eb40c3b65782d7a4291ef4604d7e.rds
#> Dataset query already saved in cache_list.json...
#> Reading cache file /tmp/Rtmpb3d2BN/eurostat/acb856c710a5db9a66c375d7a439564a.rds
#> Table namq_10_gdp read from cache file: /tmp/Rtmpb3d2BN/eurostat/acb856c710a5db9a66c375d7a439564a.rds
#>
#> --- Estimation begins ---
#> Estimating Import = FinConsExpHH + GCapitalForm
#> Constructing TOTS = GValueAdd + Import
#> Constructing StatDiscrep = TOTS - FinConsExpHH - FinConsExpGov - GCapitalForm - Export
plot(forecast_model(a))
#> No exogenous values provided. Model will forecast the exogenous values with an AR4 process (incl. Q dummies, IIS and SIS w 't.pval = 0.001').
#> Alternative is exog_fill_method = 'last'.
# }