uk_entity_search: Find names and codes of UK area entities

View source: R/uk_codes.R

uk_entity_searchR Documentation

Find names and codes of UK area entities

Description

Find names and codes of UK area entities

Usage

uk_entity_search(term = "", exact = FALSE)

Arguments

term

Either an area entity code or and an entity name

exact

If true then only exact matches to a search term will be returned and will be returned as a single string. If false then any regular expression matches to the search term will be returned.

Value

If an area code is given then the area name will be returned, if a character string is given then a tibble of entity codes and the entity names that match the string will be returned.

Examples

uk_entity_search("E09") # returns the string "London Boroughs"

uk_entity_search("London Boroughs", exact = TRUE) # return the string "E09"

uk_entity_search("Super Output Areas") # returns a tibble where entity name matches the search term


piersyork/ukmap documentation built on June 16, 2022, 3:35 a.m.