get_data_by_unit_locality {bdl}R Documentation

Get data by unit locality Id from BDL API

Description

Retrieve data for a given unit localities from BDL with specified format.

Usage

get_data_by_unit_locality(
  unitId,
  varId,
  year = NULL,
  type = c("code", "label"),
  lang = c("pl", "en"),
  ...
)

Arguments

unitId

A 12 character NUTS unit locality id with 7 characters locality individual id, separated by dash or vector of multiple unit id codes. If multiple unit codes are used, some columns are not available. Use search_unit_localities or get_unit_localities to find unit id code.

varId

A vector of variable Id's.Use search_variables or get_variables to find variable id code.

year

A vector of years. If NULL (default) returns data for all available years.

type

A type of variables returned, "code" (default), "label"

lang

A language of returned data, "pl" (default), "en"

...

Other arguments passed on to GET. For example a proxy parameters, see details.

Details

Data to retrieve from The BDL Web Services can be filtered with arguments. To get JSON data from specified directory with custom filters use get_request directly.

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

   # get_data_by_unit_locality(unitId = "030210106062-0189782", varId =  "415", type = "label")
   
   # Multi variable download
   # get_data_by_unit_locality(unitId = c("030210106062-0189782", "030210106062-0189753"), 
   #                           varId = "415")

[Package bdl version 1.0.3 Index]