Skip to contents

Inspect or change MATRIX.

Usage

px_matrix(x, value, validate)

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

Arguments

x

A px object

value

Optional. A character string. If missing, the current MATRIX is returned. If NULL, an error is thrown because MATRIX 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 MATRIX
x1 <-
   px(population_gl) |>
   px_matrix('POPULATION')

# Print MATRIX
px_matrix(x1)
#> [1] "POPULATION"