Get EFO economy projections

Downloads (and caches) the OBR Economic and Fiscal Outlook Detailed Forecast Tables - Economy file and returns quarterly economic projections for a chosen measure in tidy long format.

Usage

get_efo_economy(
  measure = c("inflation", "labour", "output_gap"),
  refresh = FALSE,
  vintage = NULL
)

Arguments

measure

Character. Which economy table to return. One of "inflation", "labour", or "output_gap". Defaults to "inflation".

refresh

Logical. If TRUE, re-download even if a cached copy exists. Defaults to FALSE.

vintage

Optional EFO vintage label such as "October 2024". If supplied, the function downloads the file for that specific EFO. If NULL (the default), the function uses any vintage set via obr_pin(), or falls back to the latest live EFO via the dynamic URL resolver.

Value

An obr_tbl with the standard v0.4.0 schema (columns: period, period_type, series, metric_type, value, unit):

period

Calendar quarter, e.g. "2025Q1" (character)

period_type

Always "quarter" for this function (character)

series

Variable name, e.g. "CPI" (character)

metric_type

One of "index", "yoy_pct", "pct", "level", classified from the series name. This is the v0.4.0 fix for the v0.3.x issue where, e.g., CPI Index values and CPI YoY values shared a single value column with no machine-readable distinction.

value

Numeric value in units described by unit

unit

One of "index", "pct", etc., paired with metric_type

Details

Data run from 2008 Q1 through the current forecast horizon. Use list_efo_economy_measures() to see all available measures.

See also

Other EFO: get_efo_fiscal(), get_efo_table(), get_monthly_profiles(), list_efo_economy_measures(), obr_efo_catalogue()

Examples

# \donttest{
op <- options(obr.cache_dir = tempdir())
try({
  inf <- get_efo_economy("inflation")
  inf[inf$series == "CPI", ]

  lab <- get_efo_economy("labour")

  # Compare CPI projections from two different EFOs
  inf_oct24 <- get_efo_economy("inflation", vintage = "October 2024")
  inf_mar26 <- get_efo_economy("inflation", vintage = "March 2026")
})
#> ℹ Downloading efo_economy.xlsx from OBR...
#> ✔ Saved to cache.
#> ℹ Loading from cache. Use `refresh = TRUE` to re-download.
#> ℹ Downloading efo_economy_october_2024.xlsx from OBR...
#> ✔ Saved to cache.
#> ℹ Downloading efo_economy_march_2026.xlsx from OBR...
#> ✔ Saved to cache.
options(op)
# }