Skip to contents

SHOWDECIMALS

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

Inspect or change SHOWDECIMALS.

Usage

px_showdecimals(x, value, validate)

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

Arguments

x

A px object

value

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

# Print SHOWDECIMALS
px_showdecimals(x1)
#> [1] "2"

# Remove SHOWDECIMALS
x2 <- px_showdecimals(x1, NULL)
px_showdecimals(x2)
#> NULL