search_units: Search for units

In bdl: Interface and Tools for 'BDL' API

Search for units

Description

Search for a given phrase in unit names.

Usage

search_units(
  name,
  level = NULL,
  year = NULL,
  kind = NULL,
  sort = c("id", "-id", "name", "-name"),
  lang = c("pl", "en"),
  ...
)

Arguments

name	A phrase to search.
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.
year	A vector of years. If NULL (default) returns data for all available years.
kind	A type of unit. More info at: https://bdl.stat.gov.pl/BDL/metadane/teryt/rodzaj
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 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

   # search_units("wro")
   # search_units("pol", type = "5")

bdl documentation built on March 7, 2023, 7:25 p.m.