Skip to contents

[Experimental]
Get information about the dimensions of a given indicator

Usage

get_dim_info(indicator, lang = "PT")

Arguments

indicator

INE indicator ID as a 7 character string. Example: "0010003".

lang

One of "PT" or "EN". Default is "PT".

Value

A data frame with dim_num (dimension number), abrv (dimension description) and versao (dimension version) for the selected indicator. A fourth column 'nota_dsg' is present for some indicators, with additional notes about the dimensions.

Details

If the indicator is not valid, returns "(PT) O codigo do indicador nao existe. / (EN) The indicator code does not exist."
Calling is_indicator_valid() before using this function is recommended.

Examples

get_dim_info("0011823", lang = "EN")
#> # A tibble: 3 × 3
#>   dim_num abrv                        versao
#>   <chr>   <chr>                       <chr> 
#> 1 1       Data reference period       XXXXX 
#> 2 2       Place of residence          03505 
#> 3 3       Type of problem encountered 05319