getWS: Walk Score API Call

Description Usage Arguments Details Value Note Author(s) References See Also Examples

View source: R/getWS.R

Description

A function to perform the basic Walk Score API call.

Usage

1
getWS(x, y, key)

Arguments

x

longitude of query location (numeric)

y

latitude of query location (numeric)

key

your Walk Score API key (string), see Details below

Details

Note that the call uses longitude and latitude coordintes and not addresses like the website interface. It is strongly recomended that Google Geolocation is used to convert addresses to coordinates because this is the method used by the Walk Score website, and will result in the same Walk Score as entering the address into the website interface. The function "geoloc" in this package is a tool for using the Google Geolocation API.

Value

Otherwise Returns an object of class WalkScore, basically a list of the following elements:

status

Status code of the request. Status of 1 indicates a successful call. See the Walk Score API page for interpretation of other codes.

walkscore

Walk Score of query location.

description

Qualitative description of location.

updated

Date and time of most recent update to this location's Walk Score.

snappedLong

grid point longitude to which the input was snapped to.

snappedLat

grid point latitude to which the input was snapped to.

Note

Visit www.walkscore.com for information on Walk Score and to obtain an API key

Author(s)

John Whalen

References

http://www.walkscore.com/professional/api.php

See Also

geoloc

Examples

1
2
3
4
## Not run: 
getWS(-73.98496,40.74807,"your key")

## End(Not run)

ajinkyaghorpade/walkscoreAPI documentation built on May 16, 2019, 6:42 p.m.