get_planning_names {onemapsgapi} | R Documentation |
Get Planning Area Names
Description
This function is a wrapper for the Names of Planning Area API. It returns the data as a tibble.
Usage
get_planning_names(token, year = NULL)
Arguments
token |
User's API token. This can be retrieved using |
year |
Optional, check documentation for valid options. Invalid requests will are ignored by the API. |
Value
A tibble with 2 columns:
- id
Planning area id
- pln_area_n
Planning area name
Examples
# returns tibble
## Not run: get_planning_names(token)
## Not run: get_planning_names(token, 2008)
# error: output is NULL, warning message shows status code
## Not run: get_planning_names("invalid_token")
[Package onemapsgapi version 2.0.0 Index]