Skip to contents

BASEPERIOD

px_baseperiod.px.Rd

Inspect or change BASEPERIOD.

Usage

px_baseperiod(x, value)

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

Arguments

x

A px object

value

Optional. A character string to set the value for all languages or a data frame with columns 'language' and 'value' to set it for specific languages. If 'value' is missing, the current BASEPERIOD is returned. If NULL, BASEPERIOD is removed.

Value

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

See also

Statistics Sweden's documentation

Examples

# Set BASEPERIOD for all languages
x1 <-
  px(population_gl) |>
  px_baseperiod('year')

# Print BASEPERIOD
px_baseperiod(x1)
#> [1] "year"

# Set BASEPERIOD for individual languages
library(tibble)
x2 <-
  x1 |>
  px_languages(c('en', 'kl')) |>
  px_baseperiod(tribble(~language, ~value,
                      'en', 'year',
                      'kl', 'ukioq'))
px_baseperiod(x2)
#> # A tibble: 2 × 2
#>   language value
#>   <chr>    <chr>
#> 1 en       year 
#> 2 kl       ukioq

# Remove BASEPERIOD
x3 <- px_baseperiod(x2, NULL)
px_baseperiod(x3)
#> NULL