View source: R/nearest_outcode.R

nearest_outcode | R Documentation |

Returns nearest outcodes for a given outcode. The search is based on the relative distance of the outcode centroid.

```
nearest_outcode(outcode, limit = 10, radius = 5000)
```

`outcode` |
A string with a UK postcode. |

`limit` |
An integer. Optional parameter. Limits number of postcodes matches to return. Defaults to 10. Needs to be less than 100. |

`radius` |
An integer. Optional parameter. Limits number of postcodes matches to return. Defaults to 5,000m. Needs to be less than 25,000m. |

A list of geographical properties.

`postcode_lookup`

for documentation.

```
nearest_outcode("EC1Y")
nearest_outcode("EC1Y", limit = 11)
nearest_outcode("EC1Y", limit = 11, radius = 6000)
```

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.