Skip to contents

Inspect or change TABLEID.

Usage

px_tableid(x, value, validate)

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

Arguments

x

A px object

value

Optional. A character string. If missing, the current TABLEID is returned. If NULL, TABLEID 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.

Examples

# Set TABLEID
x1 <-
   px(population_gl) |>
   px_tableid('POPGL')

# Print TABLEID
px_tableid(x1)
#> [1] "POPGL"

# Remove TABLEID
x2 <- px_tableid(x1, NULL)
px_tableid(x2)
#> NULL