Skip to contents

Inspect or change SOURCE.

Usage

px_source(x, value, validate)

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

Arguments

x

A px object

value

Optional. A character string to set the value for all languages or a data frame with columns 'language' and 'value' to set it for specific languages. If 'value' is missing, the current SOURCE is returned. If NULL, SOURCE is removed.

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.

Examples

# Set SOURCE for all languages
x1 <-
  px(population_gl) |>
  px_source('Statistics Greenland')

# Print SOURCE
px_source(x1)
#> [1] "Statistics Greenland"

# Set SOURCE for individual languages
library(tibble)
x2 <-
  x1 |>
  px_languages(c('en', 'kl')) |>
  px_source(tribble(~language, ~value,
                      'en', 'Statistics Greenland',
                      'kl', 'Naatsorsueqqissaartarfik'))
px_source(x2)
#> # A tibble: 2 × 2
#>   language value                   
#>   <chr>    <chr>                   
#> 1 en       Statistics Greenland    
#> 2 kl       Naatsorsueqqissaartarfik

# Remove SOURCE
x3 <- px_source(x2, NULL)
px_source(x3)
#> NULL