get_status: Retrieve WFD Status Classification Data

Description Usage Arguments Value Examples

View source: R/get_status.r

Description

Retrieves WFD Status classification data from EA Catchment Data Explorer site. Data can be retrieved by specifying waterbody id (WBID), Management Catchment (MC), Operational Catchment (OC) or River Basin District (RBD). Start year (startyr) and end year (endyr) allow specific timeranges to be downloaded. For Management Catchment (MC), Operational Catchment (OC) or River Basin District (RBD) level downloads, waterbody type can also be specified to allow extraction of specific waterbody types (River, Lake etc).

Usage

1
2
3
get_status(ea_name = NULL, column = NULL,
  level = "Overall Water Body", startyr = NULL, endyr = NULL,
  type = NULL)

Arguments

ea_name

A string representing the description (name) of the features to be extracted. For example to extract data for the whole of the Humber RBD, this would be "Humber"; also see examples. Must be an exact match to the values used in the EA database. Use the search_names function to search for specific values.

column

The column to be searched. Possible options are WBID (waterbody id), OC (Operational Catchment), MC (Management Catchment) and RBD (River Basin District)

level

The level within the WFD quality status classification to be extracted. Defaults to 'Overall Water Body'. See Vignette for possible values.

startyr

The data can be extracted for specific years using the startyr and endyr arguments. If only startyr is specified this extracts for a particular year. If no years are specified all years are returned.

endyr

The data can be extracted for specific years using the startyr and endyr arguments. The endyr should only be specified if startyr is also included, otherwise an error is returned.

type

Type of waterbody to be extracted. For Operational/Management catchment level or RBD level queries, the data can also be subset by waterbody type. Possible values are River, Lake, GroundWaterBody, TransitionalWater or CoastalWater.

Value

A data frame containing the classification details for the specified combination of criteria.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
# get Overall Water Body status classification for waterbody GB520804714300
## Not run: get_status("GB520804714300", "WBID")

# get status class based on Priority substances for waterbody GB520804714300
## Not run: get_status("GB520804714300", "WBID", level = "Priority substances")

# get the Overall Water Body status of Lakes in the Humber RBD, between
# 2012 and 2014
## Not run: get_status("Humber", "RBD", startyr = 2012, endyr = 2014, type = "Lake")

# get the Overall Water Body status for Rivers in the Avon Warwickshire
# Operational Catchment in 2011
## Not run: get_status("Avon Warwickshire", "MC", startyr = 2011, type = "River")

robbriers/cde documentation built on May 5, 2019, 7:59 p.m.