Skip to contents

UPDATE-FREQUENCY

Source: R/modify_table1.R
px_update_frequency.px.Rd

Inspect or change UPDATE-FREQUENCY.

Usage

px_update_frequency(x, value, validate)

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

Arguments

x

A px object

value

Optional. A character string. If missing, the current UPDATE-FREQUENCY is returned. If NULL, UPDATE-FREQUENCY 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 UPDATE-FREQUENCY
x1 <-
   px(population_gl) |>
   px_update_frequency('Yearly')

# Print UPDATE-FREQUENCY
px_update_frequency(x1)
#> [1] "Yearly"

# Remove UPDATE-FREQUENCY
x2 <- px_update_frequency(x1, NULL)
px_update_frequency(x2)
#> NULL