mz_place: Get details on a place

View source: R/mz-place.R

mz_placeR Documentation

Get details on a place

Description

Search functions (e.g. mz_search) return identification numbers, or gids. Use mz_place to retrieve more details about the place. See https://github.com/pelias/documentation/ for details. This function is generic, and can take a character vector of IDs, or a mapzen_geo_list as returned by mz_search and friends.

Usage

mz_place(ids, ..., api_key = NULL)

## S3 method for class 'character'
mz_place(ids, ..., api_key = NULL)

## S3 method for class 'mapzen_geo_list'
mz_place(ids, ..., gid = "gid", api_key = NULL)

Arguments

ids

A character vector of gids (see details), or a mapzen_geo_list

...

Arguments passed on to methods

api_key

Your Mapzen API key. The default is to look for the key within the provider information that was set up with 'mz_set_host'.

gid

The name of the gid field to use. Search results may include, in addition to the gid for the search result itself (the default), the gids for the country, region, county, locality and neighborhood.


tarakc02/rmapzen documentation built on Oct. 19, 2023, 7:32 p.m.