Skip to contents

Get Gazetteer Records for a given name

Source: R/01_gaz_search.R
gaz_rest_records_by_name.Rd

Get Gazetteer Records for a given name

Usage

gaz_rest_records_by_name(
  name,
  with_geometry = FALSE,
  typeid = NULL,
  language = NULL,
  like = TRUE,
  fuzzy = TRUE
)

Arguments

name

(character) Term to search in the Marine Regions Gazetteer

with_geometry

(logical) Add geometry to the result data frame? Default = FALSE

typeid

(numeric) Restrict to one or more placetypeIDs. Retrieve a list of placetypeIDs with gaz_rest_types()

language

(character) Restrict to one language. Provide as a 2 digits ISO-639. See ISOcodes::ISO_639_2.

like

(logical) Add a '%'-sign before and after the name? (SQL LIKE function). Default = TRUE

fuzzy

(logical) Use Levenshtein query to find nearest matches? Default = TRUE

Value

A data frame with Gazetteer entries

See also

gaz_rest, gaz_rest_records_by_name

Examples

if (FALSE) {
gaz_rest_records_by_name("Belgian Exclusive Economic Zone", with_geometry = TRUE)
gaz_rest_records_by_name("Bélgica", language = "es")
gaz_rest_records_by_name("Belgium", typeid = c(350, 351))
}