Get a single location from the locations resource. — get_location • openaq

Get a single location from the locations resource.

Usage

get_location(
  locations_id,
  as_data_frame = TRUE,
  dry_run = FALSE,
  rate_limit = FALSE,
  api_key = NULL
)

Arguments

locations_id: An integer representing the locations_id to request.
as_data_frame: A logical for toggling whether to return results as data frame or list defaults to TRUE.
dry_run: A logical for toggling a dry run of the request, defaults to FALSE.
rate_limit: A logical for toggling automatic rate limiting based on rate limit headers, defaults to FALSE.
api_key: A valid OpenAQ API key string, defaults to NULL.

Value

A data frame or list of results.

Examples

if (FALSE) { # \dontrun{
location <- get_location(42)
} # }