Skip to contents

OFFICIAL-STATISTICS

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

Inspect or change OFFICIAL-STATISTICS.

Usage

px_official_statistics(x, value, validate)

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

Arguments

x

A px object

value

Optional. A character string. If missing, the current OFFICIAL-STATISTICS is returned. If NULL, OFFICIAL-STATISTICS 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 OFFICIAL-STATISTICS
x1 <-
   px(population_gl) |>
   px_official_statistics('YES')

# Print OFFICIAL-STATISTICS
px_official_statistics(x1)
#> [1] "YES"

# Remove OFFICIAL-STATISTICS
x2 <- px_official_statistics(x1, NULL)
px_official_statistics(x2)
#> NULL