px_elimination.px: ELIMINATION

View source: R/modify_variable2.R

px_eliminationR Documentation

ELIMINATION

Description

Inspect or change ELIMINATION.

Usage

px_elimination(x, value, validate)

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

Arguments

x

A px object

value

Optional. A character string or data frame.

  • Use character to set ELIMINATION for all languages and STUB/HEADING variables.

  • Use data frame with columns 'variable-code', 'language' and 'elimination' to set ELIMINATION for specific variables.

  • If missing, the current ELIMINATION is returned.

  • If NULL, ELIMINATION is removed for all variables.

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, a character string, or a data frame.

See Also

Statistics Sweden's documentation

Examples

# Set ELIMINATION for all languages
x1 <-
  px(population_gl) |>
  px_elimination('YES')

# Print ELIMINATION
px_elimination(x1)

# Set ELIMINATION for individual variables
library(tibble)
x2 <-
  x1 |>
  px_elimination(tribble(~`variable-code`, ~elimination,
                    'gender', 'All',
                    'age',    'Total'))
px_elimination(x2)

# Set ELIMINATION for individual languages
x3 <-
  x2 %>%
  px_languages(c('en', 'kl')) |>
  px_elimination(tribble(~`variable-code`, ~language, ~elimination,
                    'gender',    'en',      'All_en',
                    'gender',    'kl',      'All_kl',
                    'age',       'en',      'Total_en'))
px_elimination(x3)

# Remove ELIMINATION
x4 <- px_elimination(x3, NULL)
px_elimination(x4)

pxmake documentation built on April 11, 2025, 6:06 p.m.