aq_cities: Provides a simple listing of cities within the platform.

Description Usage Arguments Details Value Examples

View source: R/cities.R

Description

Provides a simple listing of cities within the platform.

Usage

1
aq_cities(country = NULL, limit = 10000, page = NULL)

Arguments

country

Limit results by a certain country – a two-letters code see countries() for finding code based on name.

limit

Change the number of results returned, max is 10000.

page

The page of the results to query. This can be useful if e.g. there are 2000 measurements, then first use page=1 and page=2 with limit=100 to get all measurements for your query.

Details

For queries involving a city argument, the URL-encoded name of the city (as in cityURL), not its name, should be used.

Value

A results data.frame (dplyr "tbl_df") with 5 columns:

and 2 attributes, a meta data.frame (dplyr "tbl_df") with 1 line and 5 columns:

and a timestamp data.frame (dplyr "tbl_df") with the query time and the last time at which the data was modified on the platform.

Examples

1
2
3
4
5
## Not run: 
cities <- aq_cities(country = "BA")
cities

## End(Not run)

ropensci/ropenaq documentation built on March 19, 2018, 3:27 p.m.