get_flood_areas: Get the flood areas from EA

View source: R/get_flood_areas.R

get_flood_areasR Documentation

Get the flood areas from EA

Description

The flood areas API provide information on the geographic regions to which a given flood alert or warning may apply. These comprise Flood Alert Areas and Flood Warning Areas. A Flood Alert Area is a geographical area where it is possible for flooding to occur from rivers, sea and in some locations, groundwater. A single Flood Alert Area may cover a large portion of the floodplain, may contain multiple river catchments of similar characteristics and may contain a number of Flood Warning Areas. A Flood Warning Area is a geographical area where Environment Agency expect flooding to occur and which they provide a Flood Warning Service.

Usage

get_flood_areas(lat = NULL, long = NULL, dist = NULL, limit = NULL)

Arguments

lat, long, dist

Return only warnings applying to flood areas which are within dist km of the given latitude/longitude (in WGS84 coordinates), this may be approximated by a bounding box.

limit

The default limit on number of returned items is 500, this can be adjusted by giving an explicit value, there is no hard upper limit.

Details

Full information on the areas is available from the Environment Agency Spatial Data Catalogue as a downloadable file and via a Web Feature Service or Web Mapping Service. For convenience we here provide the feature information for each area as a simple JSON format, including a specification of the polygon for each area (as a geoJSON feature in WGS84 coordinates). A typical application should maintain a local copy of the geographic information rather that reply on on-demand downloads of the rather large polygon files.

Each flood warning provides a link (floodArea) to the URI of the flood area to which it applies.

Value

A dataframe of Environment Agency flood areas for the given criteria

Examples

get_flood_areas()

DavidASmith/eaflood documentation built on April 5, 2022, 4:29 a.m.