healthbR (version 0.2.0)

pof_dictionary: Get POF variable dictionary

Description

Downloads and returns the variable dictionary for POF microdata. The dictionary is cached locally to avoid repeated downloads.

Usage

pof_dictionary(
  year = "2017-2018",
  register = NULL,
  cache_dir = NULL,
  refresh = FALSE
)

Value

A tibble with variable definitions including: variable, description, position, length, decimals, register.

Arguments

year

Character. POF edition (e.g., "2017-2018"). Default is "2017-2018".

register

Character. Register name. If NULL, returns all registers. Default is NULL.

cache_dir

Character. Directory for caching downloaded files. Default uses tools::R_user_dir("healthbR", "cache").

refresh

Logical. If TRUE, re-download even if file exists in cache. Default is FALSE.

See Also

pof_variables, pof_data

Other pof: pof_cache_status(), pof_clear_cache(), pof_data(), pof_info(), pof_registers(), pof_variables(), pof_years()

Examples

if (FALSE) { # interactive()
pof_dictionary("2017-2018", "morador", cache_dir = tempdir())
}