Skip to contents

DESCRIPTIONDEFAULT

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

Inspect or change DESCRIPTIONDEFAULT.

Usage

px_descriptiondefault(x, value, validate)

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

Arguments

x

A px object

value

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

# Print DESCRIPTIONDEFAULT
px_descriptiondefault(x1)
#> [1] "YES"

# Remove DESCRIPTIONDEFAULT
x2 <- px_descriptiondefault(x1, NULL)
px_descriptiondefault(x2)
#> NULL