% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/efo_catalogue.R
\name{obr_efo_catalogue}
\alias{obr_efo_catalogue}
\title{List the EFO detailed-forecast tables this package can fetch}
\usage{
obr_efo_catalogue()
}
\value{
A data frame with columns:
\describe{
\item{table_id}{The EFO table identifier (e.g. \code{"6.5"}, \code{"1.7"}).}
\item{file}{Which EFO workbook the table sits in: \code{"aggregates"} or
\code{"economy"}.}
\item{section}{Theme tag (e.g. \code{"GDP"}, \code{"Labour"}, \code{"Debt"}).}
\item{title}{Human-readable title taken from the OBR contents page.}
\item{layout}{Layout family the parser uses: \code{"quarterly_wide"},
\code{"quarterly_single"}, \code{"annual_year_wide"}, \code{"fiscal_year_wide"},
or \code{"cross_reference"}.}
\item{default_metric_type}{Default \code{metric_type} applied to series
whose name does not signal otherwise. \code{NA} lets the heuristic decide
per row.}
\item{default_unit}{Default \code{unit} for the same.}
}
}
\description{
Returns a data frame describing every Detailed Forecast Table in the OBR
Economic and Fiscal Outlook (Aggregates and Economy workbooks) that
\code{\link[=get_efo_table]{get_efo_table()}} knows how to parse.
}
\details{
Use this catalogue to discover which tables are available, what each
contains, and the default \code{metric_type} / \code{unit} \code{get_efo_table()} will
attach. Pass any \code{table_id} to \code{\link[=get_efo_table]{get_efo_table()}}.

Coverage: 17 fiscal aggregates tables (Section 6) plus 22 macro economy
tables (Section 1). One sheet (6.11) is currently a cross-reference to
a previous EFO and returns \code{NULL} with a warning rather than data.
}
\examples{
head(obr_efo_catalogue())

# All tables in the Debt section
cat <- obr_efo_catalogue()
cat[cat$section == "Debt", c("table_id", "title")]

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