Skip to contents

Inspect or change STOCKFA.

Usage

px_stockfa(x, value)

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

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 STOCKFA is returned. If NULL, STOCKFA is removed.

Value

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

Examples

# Set STOCKFA for all languages
x1 <-
  px(population_gl) |>
  px_stockfa('S')

# Print STOCKFA
px_stockfa(x1)
#> [1] "S"

# Set STOCKFA for individual languages
library(tibble)
x2 <-
  x1 |>
  px_languages(c('en', 'kl')) |>
  px_stockfa(tribble(~language, ~value,
                      'en', 'S',
                      'kl', 'F'))
px_stockfa(x2)
#> # A tibble: 2 × 2
#>   language value
#>   <chr>    <chr>
#> 1 en       S    
#> 2 kl       F    

# Remove STOCKFA
x3 <- px_stockfa(x2, NULL)
px_stockfa(x3)
#> NULL