Skip to contents

VALUES

Source: R/modify_cells2.R
px_values.px.Rd

Inspect or change VALUES.

Usage

px_values(x, value, validate)

# S3 method for class 'px'
px_values(x, value, validate = TRUE)

Arguments

x

A px object

value

Optional. A data frame with the columns 'values' and one or more of the columns: 'variable-code', 'code', and 'language'. If 'value' is missing, the current VALUES is returned. If NULL, VALUES is removed.

validate

Optional. If TRUE a number of validation checks are performed on the px object, and an error is thrown if the object is not valid. If FALSE, the checks are skipped, which can be usefull for large px objects where the check can be time consuming. Use px_validate() to manually preform the check.

Value

A px object or data frame.

See also

Statistics Sweden's documentation

Examples

# Set VALUES for a value
library(tibble)
x1 <-
  population_gl |>
  px() |>
  px_values(
    tribble(~`variable-code`, ~code,  ~values,
            'year', '2004', 'Year 2024'))

# Print VALUES
px_values(x1)
#> # A tibble: 10 × 4
#>    `variable-code` code   language value    
#>    <chr>           <chr>  <chr>    <chr>    
#>  1 year            2004   NA       Year 2024
#>  2 age             0-6    NA       0-6      
#>  3 age             17-24  NA       17-24    
#>  4 age             25-64  NA       25-64    
#>  5 age             65+    NA       65+      
#>  6 age             7-16   NA       7-16     
#>  7 gender          female NA       female   
#>  8 gender          male   NA       male     
#>  9 year            2014   NA       2014     
#> 10 year            2024   NA       2024     

# Set VALUES for a value in specific language
x2 <-
  x1 |>
  px_languages(c('en', 'kl')) |>
  px_values(
    tribble(~`variable-code`, ~code,  ~language, ~values,
            'age', '0-6', 'en', 'toddler',
            'age', '0-6', 'kl', 'meeraaqqap'))
px_values(x2)
#> # A tibble: 2 × 4
#>   `variable-code` code  language value     
#>   <chr>           <chr> <chr>    <chr>     
#> 1 age             0-6   en       toddler   
#> 2 age             0-6   kl       meeraaqqap

# Remove VALUES
x3 <- px_values(x2, NULL)
px_values(x3)
#> NULL