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
descriptioncolumn 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)
#> series_name api_path table_id variable_id
#> <char> <char> <int> <int>
#> 1: taxapartic /t/5944/n1/all/v/4096/p/all/d/v4096%201 5944 4096
#> 2: nivelocup /t/6379/n1/all/v/4097/p/all/d/v4097%201 6379 4097
#> 3: niveldesocup /t/6380/n1/all/v/4098/p/all/d/v4098%201 6380 4098
#> 4: popnaforca /t/6318/n1/all/v/1641/p/all/c629/32386 6318 1641
#> 5: popocup /t/6318/n1/all/v/1641/p/all/c629/32387 6318 1641
#> 6: popdesocup /t/6318/n1/all/v/1641/p/all/c629/32446 6318 1641
#> classification_id classification_value theme theme_category
#> <char> <char> <char> <char>
#> 1: <NA> <NA> labor_market participation
#> 2: <NA> <NA> labor_market participation
#> 3: <NA> <NA> labor_market participation
#> 4: c629 32386 labor_market participation
#> 5: c629 32387 labor_market participation
#> 6: c629 32446 labor_market participation
#> subcategory description_pt
#> <char> <char>
#> 1: rates Taxa de participacao na forca de trabalho
#> 2: rates Nivel de ocupacao
#> 3: rates Nivel de desocupacao
#> 4: levels Populacao na forca de trabalho
#> 5: levels Populacao ocupada
#> 6: levels Populacao desocupada
#> description_en unit unit_label_pt unit_label_en
#> <char> <char> <char> <char>
#> 1: Labor force participation rate percent % %
#> 2: Employment-population ratio percent % %
#> 3: Unemployment-population ratio percent % %
#> 4: Labor force thousands mil pessoas thousands
#> 5: Employed population thousands mil pessoas thousands
#> 6: Unemployed population thousands mil pessoas thousands
#> is_derived requires_deflation description
#> <lgcl> <lgcl> <char>
#> 1: TRUE FALSE Taxa de participacao na forca de trabalho
#> 2: TRUE FALSE Nivel de ocupacao
#> 3: TRUE FALSE Nivel de desocupacao
#> 4: FALSE FALSE Populacao na forca de trabalho
#> 5: FALSE FALSE Populacao ocupada
#> 6: FALSE FALSE Populacao desocupada
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")