Skip to contents

VALUENOTE

px_valuenote.px.Rd

Inspect or change VALUENOTE.

Usage

px_valuenote(x, value)

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

Arguments

x

A px object

value

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

Value

A px object or data frame.

See also

Statistics Sweden's documentation

Examples

# Set VALUENOTE for a value
library(tibble)
x1 <-
  population_gl |>
  px() |>
  px_valuenote(
    tribble(~`variable-code`, ~code,  ~valuenote,
            'year', '2004', 'Counts are approximated'))

# Print VALUENOTE
px_valuenote(x1)
#> # A tibble: 1 × 4
#>   `variable-code` code  language valuenote              
#>   <chr>           <chr> <chr>    <chr>                  
#> 1 year            2004  NA       Counts are approximated

# Set VALUENOTE for a value in specific language
x2 <-
  x1 |>
  px_languages(c('en', 'kl')) |>
  px_valuenote(
    tribble(~`variable-code`, ~code,  ~language, ~valuenote,
            'age', '0-6', 'en', 'Some of the figures are from 2003',
            'age', '0-6', 'kl', 'Kisitsisit ilaat 2003-imeersuupput'))
px_valuenote(x2)
#> # A tibble: 2 × 4
#>   `variable-code` code  language valuenote                         
#>   <chr>           <chr> <chr>    <chr>                             
#> 1 age             0-6   en       Some of the figures are from 2003 
#> 2 age             0-6   kl       Kisitsisit ilaat 2003-imeersuupput

# Remove VALUENOTE
x3 <- px_valuenote(x2, NULL)
px_valuenote(x3)
#> NULL