Skip to contents

Inspect or change ELIMINATION.

Usage

px_elimination(x, value)

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

Arguments

x

A px object

value

Optional. A character string or data frame.

  • Use character to set ELIMINATION for all languages and 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.

Value

A px object, a character string, or a data frame.

Examples

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

# Print ELIMINATION
px_elimination(x1)
#> [1] "YES"

# Set ELIMINATION for individual variables
library(tibble)
x2 <-
  x1 |>
  px_elimination(tribble(~`variable-code`, ~elimination,
                    'gender', 'All',
                    'age',    'Total'))
px_elimination(x2)
#> # A tibble: 4 × 2
#>   `variable-code` elimination
#>   <chr>           <chr>      
#> 1 gender          All        
#> 2 age             Total      
#> 3 year            YES        
#> 4 n               YES        

# 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)
#> # A tibble: 3 × 3
#>   `variable-code` language elimination
#>   <chr>           <chr>    <chr>      
#> 1 gender          en       All_en     
#> 2 gender          kl       All_kl     
#> 3 age             en       Total_en   

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