get_sidra_series_metadata: Get SIDRA Series Metadata

In PNADCperiods: Identify Reference Periods in Brazil's PNADC Survey Data

Get SIDRA Series Metadata

Description

Returns a data.table with metadata for all PNADC rolling quarter series available from IBGE's SIDRA API.

Usage

get_sidra_series_metadata(
  series = "all",
  theme = NULL,
  theme_category = NULL,
  subcategory = NULL,
  lang = "pt"
)

Arguments

series	Character vector of series names to retrieve, or "all" (default) for all series.
theme	Character vector of themes to filter by. Valid themes: "labor_market", "earnings", "demographics", "social_protection", "prices". Use NULL (default) for no filtering.
theme_category	Character vector of theme categories to filter by. Use NULL (default) for no filtering.
subcategory	Character vector of subcategories to filter by. Use NULL (default) for no filtering.
lang	Character. Language for descriptions: "pt" (Portuguese, default) or "en" (English). When "en", the description column contains English text.

Value

A data.table with columns:

series_name

Character. Internal name used in the package

api_path

Character. SIDRA API path for get_sidra()

table_id

Integer. SIDRA table number

variable_id

Integer. SIDRA variable code

theme

Character. Top-level theme

theme_category

Character. Middle-level category within theme

subcategory

Character. Optional subcategory for filtering

description_pt

Character. Portuguese description

description_en

Character. English description

description

Character. Description in the requested language

unit

Character. Unit of measurement

unit_label_pt

Character. Unit label in Portuguese

unit_label_en

Character. Unit label in English

is_derived

Logical. TRUE if computed from other series

requires_deflation

Logical. TRUE if needs IPCA deflation

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")

PNADCperiods documentation built on April 28, 2026, 9:07 a.m.