Inspect or change CELLNOTEX.
Usage
px_cellnotex(x, value, na_to_star, validate)
# S3 method for class 'px'
px_cellnotex(x, value, na_to_star = TRUE, validate = TRUE)Arguments
- x
A px object
- value
Optional. A data frame with columns 'cellnotex' and one or more columns with the names of the STUB and HEADING variables. The 'cellnotex' column is the cellnotex text, and the STUB/HEADING columns control which cells the note applies to. Use star (*) if a note applies to all cells in a variable. Use column 'language' to set CELLNOTEX for specific languages. If 'value' is missing, the current CELLNOTEX is returned. If value is NULL, CELLNOTEX is removed.
- na_to_star
Optional. Convert all NAs to '*'.
- 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.
Examples
# Set CELLNOTEX for a value
library(tibble)
x1 <-
population_gl |>
px() |>
px_cellnotex(
tribble(~gender, ~age, ~year, ~cellnote,
'male', '0-6', '2004', 'Approximation'))
x2 <-
x1 |>
px_cellnote(
tribble(~gender, ~age, ~year, ~cellnote,
'female', '*', '2014', 'Uncertainty in ages'))
# Print CELLNOTEX
px_cellnotex(x2)
#> # A tibble: 2 × 4
#> gender age year cellnotex
#> <chr> <chr> <chr> <chr>
#> 1 male 0-6 2004 NA
#> 2 female * 2014 NA
# Set CELLNOTEX in multiple languagese
x3 <-
x1 |>
px_languages(c('en', 'kl')) |>
px_cellnotex(
tribble(~age, ~year, ~language, ~cellnote,
'*', '2003', 'en', 'Some of the figures are from 2003',
'*', '2003', 'kl', 'Kisitsisit ilaat 2003-imeersuupput'))
px_cellnotex(x3)
#> # A tibble: 4 × 5
#> gender age year language cellnotex
#> <chr> <chr> <chr> <chr> <chr>
#> 1 male 0-6 2004 en NA
#> 2 male 0-6 2004 kl NA
#> 3 * * 2003 en NA
#> 4 * * 2003 kl NA
# Remove CELLNOTEX
x4 <- px_cellnotex(x3, NULL)
px_cellnotex(x4)
#> NULL