% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/monthly_profiles.R
\name{get_monthly_profiles}
\alias{get_monthly_profiles}
\title{Get the OBR monthly profiles for the public finances}
\usage{
get_monthly_profiles(
  sheet = c("profiles", "cgncr"),
  vintage = NULL,
  refresh = FALSE
)
}
\arguments{
\item{sheet}{Which profile table to return. \code{"profiles"} (the default)
returns the receipts and spending profiles; \code{"cgncr"} returns the
central government net cash requirement breakdown.}

\item{vintage}{Optional EFO vintage label such as \code{"March 2026"}. If
\code{NULL} (the default), uses any pin set via \code{\link[=obr_pin]{obr_pin()}} or resolves the
latest live profiles workbook.}

\item{refresh}{Logical. If \code{TRUE}, re-download even if a cached copy
exists. Defaults to \code{FALSE}.}
}
\value{
An \code{obr_tbl} with the standard schema columns (\code{period},
\code{period_type}, \code{series}, \code{metric_type}, \code{value}, \code{unit}). Monthly rows
have \code{period_type = "month"} and \code{period} in \code{"YYYY-MM"} format; each
series also carries one \code{period_type = "fiscal_year"} row holding the
full-year EFO forecast the profile sums to. All values are GBP billion.
}
\description{
Downloads (and caches) the monthly profiles workbook the OBR publishes
alongside each \emph{Economic and Fiscal Outlook}. The profiles apportion
the full-year EFO forecast for receipts, spending, and the central
government net cash requirement (CGNCR) across the twelve months of the
fiscal year, so that each month's ONS/HMT public sector finances outturn
can be judged against the path implied by the OBR's forecast.
}
\details{
This is the reference point used every month in the run-up to a fiscal
event ("borrowing so far this year vs the OBR profile"). The OBR itself
publishes a monthly commentary against these profiles; this function
provides the underlying numbers in tidy long format. Pair with monthly
outturn data (e.g. from the ONS public sector finances release) to
compute in-year deviations from profile.

The profiles workbook is typically published a few weeks after the EFO
itself. The OBR describes the profiles as broad-brush and illustrative;
see the Notes sheet of the source workbook.
}
\examples{
\donttest{
op <- options(obr.cache_dir = tempdir())

mp <- tryCatch(get_monthly_profiles(), error = function(e) NULL)
if (!is.null(mp)) {
  # Monthly profile for HMRC cash receipts
  mp[mp$series == "HMRC cash receipts" & mp$period_type == "month", ]
}

# CGNCR breakdown by month
cg <- tryCatch(get_monthly_profiles("cgncr"), error = function(e) NULL)

options(op)
}

}
\seealso{
Other EFO: 
\code{\link{get_efo_economy}()},
\code{\link{get_efo_fiscal}()},
\code{\link{get_efo_table}()},
\code{\link{list_efo_economy_measures}()},
\code{\link{obr_efo_catalogue}()}
}
\concept{EFO}
