get_regionclassification: Get region classifications / code-name keys

In pttry/statficlassifications: Statistics Finland Statistical Classification API interface

Get region classifications / code-name keys

Description

Get region classifications / code-name keys

Usage

get_regionclassification(
  ...,
  year = NULL,
  only_names = FALSE,
  only_codes = FALSE,
  as_named_vector = FALSE,
  lang = "fi",
  offline = TRUE
)

Arguments

...	character(s), (vector), region(s) of required keys.
year	character/numeric, year of the required keys. As default returns a general classification containing also abolished municipalities.
only_names	logical, whether to return only the names in the classification. Defaults to FALSE.
only_codes	logical, whether to return only the codes in the classification. Defaults to FALSE.
as_named_vector	logical, whether returns the key as a named vector rather than a data.frame. Defaults FALSE.
lang	"fi", "sv" or "en". Language of the classification required. Defaults to "fi".
offline	logical, whether uses the key in the package data. Defaults TRUE.
suppress_message	logical, whether to suppress any messages the function might produce.

Value

a data.frame or a named vector. A region code-name key.

Examples

get_regionclassification("seutukunta")
get_regionclassification("seutukunta", as_named_vector = TRUE)
get_regionclassification("seutukunta", "maakunta")

pttry/statficlassifications documentation built on Jan. 17, 2024, 4:36 p.m.