geo_search: Geographic search NYTimes API

In ropengov/rtimes: Client for New York Times 'APIs'

Description

Geographic search NYTimes API

Usage

geo_search(name = NULL, latitude = NULL, longitude = NULL,
  elevation = NULL, population = NULL, country_code = NULL,
  country_name = NULL, admin_code1 = NULL, admin_name1 = NULL,
  admin_code2 = NULL, admin_name2 = NULL, admin_code3 = NULL,
  admin_name3 = NULL, admin_code4 = NULL, admin_name4 = NULL,
  feature_class = NULL, feature_class_name = NULL,
  feature_code_name = NULL, time_zone_id = NULL, dst_offset = NULL,
  gmt_offset = NULL, bounding_box = NULL, nearby = NULL,
  offset = NULL, limit = 100, key = NULL, ...)

Arguments

name	(character) A displayable name for the specified place.
latitude	(numeric) The latitude of the specified place.
longitude	(numeric) The longitude of the specified place.
elevation	(character) The elevation of the specified place, in meters.
population	(numeric) Te population of the specified place.
country_code	(character) The country code, as given in ISO-3611, of the specified place.
country_name	(character) The country name of the specified place.
admin_code1	(character) A code for the first level administrative division containing the specified place. In the case of US locations this will be the containing state's postal code. All geonames admin_code1 records can be found at http://download.geonames.org/export/dump/admin1Codes.txt.
admin_name1	(character) The name of the first level administrative division containing the specified place. In the case of US locations this will be the full name of the containing State.
admin_code2	(character) A code for the second level administrative division containing the specified place. In the case of US locations this will be a code for the containing county. All geonames admin_code2 records can be found at http://download.geonames.org/export/dump/admin2Codes.txt
admin_name2	(character) The name of the second level administrative division containing the specified place. In the case of US locations this will be the name of the containing county.
admin_code3	(character) A code for the third level administrative division containing the specified place. This is infrequently used and never used for US locations.
admin_name3	(character) The name of the third level administrative division containing the specified place. This is infrequently used and never used for US locations.
admin_code4	(character) A code for the fourth level administrative division containing the specified place. This is infrequently used and never used for US locations.
admin_name4	(character) The name of the fourth level administrative division containing the specified place. This is infrequently used and never used for US locations.
feature_class	(character) The high-level feature class of the location. The feature classes are as follows: A - Administrative Boundary Features H - Hydrographic Features L - Area Features P - Populated Place Features R - Road / Railroad Features S - Spot Features T - Hypsographic Features U - Undersea Features V - Vegetation Features
feature_class_name	(character) See list of name values associated with feature_class above.
feature_code_name	(character) A code for the type of feature represented by this geonames record. The complete list of feature codes can be found at http://download.geonames.org/export/dump/featureCodes_en.txt.
time_zone_id	(character) The time zone containing this geonames record.
dst_offset	(numeric) The offset from GMT during daylight savings time.
gmt_offset	(numeric) The offset from GMT during standard time.
bounding_box	(numeric) Vector of coordinates in the following format <NE Latitude>, <NE Longitude>,<SW Latitude>,<SW Longitude>. For example: c(39.985417852135356,-93.18850617968747,37.84003257271992,-95.94607453906247)
nearby	(numeric) A latitude longitude pair (e.g. 41.9,12.5). When provided with this parameter, the geocodes API will return the 20 results that are geographically nearest to the specified latitude/longitude pair.
offset	(numeric) The offset in the results. BEWARE - this parameter doesn't work now (as of 2014-10-21).
limit	(numeric) If not specified 20 results are returned. Otherwise the specified number of results or a maximum of 20 results are returned. BEWARE - this parameter doesn't work now (as of 2015-08-10).
key	your New York Times API key; pass in, or loads from .Rprofile as nytimes_api_key, or from .Renviron as NYTIMES_API_KEY
...	Curl options (debugging tools mostly) passed to crul::HttpClient

Details

BEWARE: the docs are a hot mess - the README page has examples that include parameters that are not in their list of accepted query parameters. Some query parameter that used to work don't work now. There seems to be no way to get a response from them. So good luck.

References

http://developer.nytimes.com, https://developer.nytimes.com/docs/geo-product/1/routes/query.json/get

Examples

## Not run: 
geo_search(country_code = 'US', verbose = TRUE)
geo_search(feature_class='P', country_code='US', population='50000_')

# curl options
geo_search(country_code = 'US', verbose = TRUE)

## End(Not run)

ropengov/rtimes documentation built on July 21, 2019, 5:27 a.m.