Skip to contents

CONFIDENTIAL

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

Inspect or change CONFIDENTIAL.

Usage

px_confidential(x, value, validate)

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

Arguments

x

A px object

value

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

# Print CONFIDENTIAL
px_confidential(x1)
#> [1] "1"

# Remove CONFIDENTIAL
x2 <- px_confidential(x1, NULL)
px_confidential(x2)
#> NULL