get_units: Get unit NUTS codes.

In KaniaKrzysztof/bdl: Interface and Tools for BDL API

Description

Retrieve all unit codes or sub to given unit,

Usage

get_units(parentId = "", level = NULL, sort = c("id", "-id", "name",
  "-name"), lang = c("pl", "en"), ...)

Arguments

parentId	A 12 character NUTS id code of parent unit. Use search_units to find unit id code.
level	A number from 0 to 6, filters the returned unit by its level. If NULL (default) no level filters apply. Use get_levels to find more info.
sort	A type of sorting, "id" (default), "-id", "name", "-name"
lang	A language of returned data, "pl" (default), "en"
...	Other arguments passed on to GET. For example a proxy parameters, see details.

Details

To get all units skip the parentId parameter. Warining! Downloading all unit can take around 1 minute.

To use a proxy to connect, a use_proxy can be passed to GET. For example get_request(id, filters, config = httr::use_proxy(url, port, username, password)).

Value

A dataset as a tibble.

Examples

 ## Not run: 
    units <- get_units()
    units <- get_units("010000000000")

## End(Not run)

KaniaKrzysztof/bdl documentation built on June 28, 2019, 8:09 p.m.