px_note {pxmake} | R Documentation |
NOTE
Description
Inspect or change NOTE.
Usage
px_note(x, value, validate)
## S3 method for class 'px'
px_note(x, value, validate = TRUE)
Arguments
x |
A px object |
value |
Optional. A character string, a data frame, or a list.
|
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 |
Details
NOTE has a lot of possible ways to specify value
, because
it can be set both for the entire PX-file and for individual variables.
Value
A px object, a character string, a data frame, or a list of character strings and/or data frames.
See Also
Statistics Sweden's documentation
Examples
library(tibble)
# Set NOTE for entire PX-file
x1 <-
px(population_gl) |>
px_note('Note about PX-file')
# Print NOTE
px_note(x1)
# Set NOTE for entire PX-file in multiple languages
x2 <-
x1 |>
px_languages(c('en', 'kl')) |>
px_note(tribble(~language, ~value,
'en', 'English note',
'kl', 'Kalaallisut note'
)
)
px_note(x2)
# Set NOTE for variables
x3 <-
x1 |>
px_note(tribble(~`variable-code`, ~note,
'year', 'Some data collected in following year',
'age', 'Is rounded down'
)
)
px_note(x3)
# Remove all NOTEs
x4 <- px_note(x3, NULL)