Skip to contents

Inspect or change DESCRIPTIONDEFAULT.

Usage

px_descriptiondefault(x, value)

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

Arguments

x

A px object

value

Optional. A character string. If missing, the current DESCRIPTIONDEFAULT is returned. If NULL, DESCRIPTIONDEFAULT is removed.

Value

A px object or a character string.

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