nearest_postcode: Nearest postcode

Description Usage Arguments Value Examples

View source: R/nearest_postcode.R

Description

Returns nearest postcodes for a given postcode.

Usage

1
nearest_postcode(postcode, limit = 10, radius = 100)

Arguments

postcode

A string. Valid UK postcode.

limit

A string or integer. Limits number of postcodes matches to return. Defaults to 10. Needs to be lower than 100.

radius

Limits number of postcodes matches to return. Defaults to 100m. Needs to be less than 2,000m.

Value

A list of geographic properties of the nearest postcode.

Examples

1
2
3
nearest_postcode("EC1Y 8LX")
nearest_postcode("EC1Y 8LX", limit = 11)
nearest_postcode("EC1Y 8LX", limit = 12, radius = 200)

erzk/PostcodesioR documentation built on Dec. 18, 2017, 11:22 a.m.