search_unit_localities {bdl}R Documentation

Search for unit localities

Description

Search for a given phrase in unit locality names.

Usage

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

Arguments

name

A phrase to search.

year

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

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_unit_localities("wro")

[Package bdl version 1.0.3 Index]