sotkanet (version 0.10.1)

sotkanet_regions: Sotkanet Regions

Description

Retrieves sotkanet regions data.

Usage

sotkanet_regions(
  type = "table",
  lang = "fi",
  user.agent = NULL,
  cache = TRUE,
  cache_dir = NULL
)

Value

data.frame

Arguments

type

type output format, either 'table' (default) or 'raw'. Default produces a truncated table with strictly defined columns that are useful in other functions. 'Raw' produces the full output which might be useful for exploratory purposes.

lang

Language of the output.

user.agent

"User agent" defined by the user. Default is NULL which will then use the package identifier "rOpenGov/sotkanet"

cache

a logical whether to do caching.

cache_dir

a path to the cache directory.

Author

Maintainer: Leo Lahti

Details

Data is fetched from https://sotkanet.fi/rest/1.1/regions.

References

See citation("sotkanet")

Examples

if (FALSE) {
sotkanet.regions <- sotkanet_regions(type = "table", lang = "fi")
}