% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/sidra-series-metadata.R
\name{get_sidra_series_metadata}
\alias{get_sidra_series_metadata}
\title{Get SIDRA Series Metadata}
\usage{
get_sidra_series_metadata(
  series = "all",
  theme = NULL,
  theme_category = NULL,
  subcategory = NULL,
  lang = "pt"
)
}
\arguments{
\item{series}{Character vector of series names to retrieve, or "all" (default)
for all series.}

\item{theme}{Character vector of themes to filter by. Valid themes:
"labor_market", "earnings", "demographics", "social_protection", "prices".
Use NULL (default) for no filtering.}

\item{theme_category}{Character vector of theme categories to filter by.
Use NULL (default) for no filtering.}

\item{subcategory}{Character vector of subcategories to filter by.
Use NULL (default) for no filtering.}

\item{lang}{Character. Language for descriptions: "pt" (Portuguese, default)
or "en" (English). When "en", the \code{description} column contains English text.}
}
\value{
A data.table with columns:
\describe{
\item{series_name}{Character. Internal name used in the package}
\item{api_path}{Character. SIDRA API path for get_sidra()}
\item{table_id}{Integer. SIDRA table number}
\item{variable_id}{Integer. SIDRA variable code}
\item{theme}{Character. Top-level theme}
\item{theme_category}{Character. Middle-level category within theme}
\item{subcategory}{Character. Optional subcategory for filtering}
\item{description_pt}{Character. Portuguese description}
\item{description_en}{Character. English description}
\item{description}{Character. Description in the requested language}
\item{unit}{Character. Unit of measurement}
\item{unit_label_pt}{Character. Unit label in Portuguese}
\item{unit_label_en}{Character. Unit label in English}
\item{is_derived}{Logical. TRUE if computed from other series}
\item{requires_deflation}{Logical. TRUE if needs IPCA deflation}
}
}
\description{
Returns a data.table with metadata for all PNADC rolling quarter series
available from IBGE's SIDRA API.
}
\examples{
meta <- get_sidra_series_metadata()
head(meta)

labor <- get_sidra_series_metadata(theme = "labor_market")

unemp <- get_sidra_series_metadata(theme = "labor_market",
                                    theme_category = "unemployment")

meta_en <- get_sidra_series_metadata(series = c("taxadesocup", "popocup"),
                                     lang = "en")

}
