TIMEVAL — px_timeval • pxmake

Inspect or change TIMEVAL.

There can only be one time variable.

Usage

px_timeval(x, value, validate)

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

Arguments

x: A px object
value: Optional. A character string. If missing, the current TIMEVAL is returned. If NULL, TIMEVAL 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 a character string.

See also

Statistics Sweden's documentation

Examples

# Set TIMEVAL
x1 <-
   px(population_gl) |>
   px_timeval('year')

# Print TIMEVAL
px_timeval(x1)
#> [1] "year"

# Remove TIMEVAL
x2 <- px_timeval(x1, NULL)
px_timeval(x2)
#> NULL