Skip to contents

Inspect or change MAP.

Usage

px_map(x, value)

# S3 method for class 'px'
px_map(x, value)

Arguments

x

A px object

value

Optional. A character string or data frame.

  • Use character to set MAP for all languages and STUB/HEADING variables.

  • Use data frame with columns 'variable-code', 'language' and 'map' to set MAP for specific variables.

  • If missing, the current MAP is returned.

  • If NULL, MAP is removed for all variables.

Value

A px object, a character string, or a data frame.

Examples

# Set MAP for all languages
x1 <-
  px(population_gl) |>
  px_map('greenland')

# Print MAP
px_map(x1)
#> # A tibble: 3 × 2
#>   `variable-code` map      
#>   <chr>           <chr>    
#> 1 gender          greenland
#> 2 age             greenland
#> 3 year            greenland

# Set MAP for individual variables
library(tibble)
x2 <-
  x1 |>
  px_map(tribble(~`variable-code`, ~map,
                    'gender', 'cities',
                    'age',    'municipalities'))
px_map(x2)
#> # A tibble: 3 × 2
#>   `variable-code` map           
#>   <chr>           <chr>         
#> 1 gender          cities        
#> 2 age             municipalities
#> 3 year            greenland     

# Set MAP for individual languages
x3 <-
  x2 %>%
  px_languages(c('en', 'kl')) |>
  px_map(tribble(~`variable-code`, ~language, ~map,
                    'gender',    'en',      'cities_en',
                    'gender',    'kl',      'cities_kl',
                    'age',       'en',      'municipalities_en'))
px_map(x3)
#> # A tibble: 3 × 3
#>   `variable-code` language map              
#>   <chr>           <chr>    <chr>            
#> 1 gender          en       cities_en        
#> 2 gender          kl       cities_kl        
#> 3 age             en       municipalities_en

# Remove MAP
x4 <- px_map(x3, NULL)
px_map(x4)
#> NULL