STUB

Inspect or change STUB.

Usage

px_stub(x, value, validate)

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

Arguments

x

A px object

value

Optional. A character vector of variable names to change to STUB. This also changes the STUB order. With names in variables becoming 1, 2, ... If missing, the current STUB variables are returned.

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 vector.

See also

Statistics Sweden's documentation

px_heading px_figures

Examples

x1 <- px(population_gl)
# Print STUB
px_stub(x1)
#> [1] "gender" "age"   
# Add 'year' to STUB
x2 <- px_stub(x1, 'year')
px_stub(x2)
#> [1] "year"   "gender" "age"   

# Change order of STUB
x3 <- px_stub(x2, c('age', 'gender'))
px_stub(x3)
#> [1] "age"    "gender" "year"