Skip to contents

AGGREGALLOWED

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

Inspect or change AGGREGALLOWED.

Usage

px_aggregallowed(x, value, validate)

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

Arguments

x

A px object

value

Optional. A character string. If missing, the current AGGREGALLOWED is returned. If NULL, AGGREGALLOWED 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 AGGREGALLOWED
x1 <-
   px(population_gl) |>
   px_aggregallowed('NO')

# Print AGGREGALLOWED
px_aggregallowed(x1)
#> [1] "NO"

# Remove AGGREGALLOWED
x2 <- px_aggregallowed(x1, NULL)
px_aggregallowed(x2)
#> NULL