Skip to contents

Inspect or change DECIMALS.

Usage

px_decimals(x, value, validate)

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

Arguments

x

A px object

value

Optional. A character string. If missing, the current DECIMALS is returned. If NULL, an error is thrown because DECIMALS cannot be 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.

Examples

# Set DECIMALS
x1 <-
   px(population_gl) |>
   px_decimals('3')

# Print DECIMALS
px_decimals(x1)
#> [1] "3"