Skip to contents

TITLE

Source: R/modify_table2.R
px_title.px.Rd

Inspect or change TITLE.

TITLE can only be removed if DESCRIPTION is set.

Usage

px_title(x, value, validate)

# S3 method for class 'px'
px_title(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 TITLE is returned. If NULL, TITLE 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.

See also

Statistics Sweden's documentation

px_description()

Examples

# Set TITLE for all languages
x1 <-
  px(population_gl) |>
  px_title('Population GR')

# Print TITLE
px_title(x1)
#> [1] "Population GR"

# Set TITLE for individual languages
library(tibble)
x2 <-
  x1 |>
  px_languages(c('en', 'kl')) |>
  px_title(tribble(~language, ~value,
                      'en', 'Population GR',
                      'kl', 'Innuttaasut KL'))
px_title(x2)
#> # A tibble: 2 × 2
#>   language value         
#>   <chr>    <chr>         
#> 1 en       Population GR 
#> 2 kl       Innuttaasut KL