get_status | R Documentation |
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).
get_status(
ea_name = NULL,
column = NULL,
level = "Overall Water Body",
startyr = NULL,
endyr = NULL,
type = NULL
)
ea_name |
A string representing the description ( | ||||||||||||||||||||||||||||||||||
column |
The column to be searched. Possible options are
| ||||||||||||||||||||||||||||||||||
level |
The level within the WFD quality classification elements that objectives have been set at. For full details of the hierarchy of elements within the classification used, see https://environment.data.gov.uk/catchment-planning/help/usage#catchment-hierarchy. Defaults to 'Overall Water Body'. Possible values for the different levels retrieved by the function are shown below.
| ||||||||||||||||||||||||||||||||||
startyr |
The data can be extracted for specific years using the
| ||||||||||||||||||||||||||||||||||
endyr |
The data can be extracted for specific years using the
| ||||||||||||||||||||||||||||||||||
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 |
An object of class cde_df
containing the classification
details for the specified combination of criteria.
For details of the meaning of the the different columns returned,
see https://docs.ropensci.org/cde/articles/cde-output-reference.html.
# get Overall Water Body status classification for waterbody GB520804714300
get_status(ea_name="GB520804714300", column="WBID")
# get status class based on Priority substances for waterbody GB520804714300
get_status(ea_name="GB520804714300", column="WBID", level="Priority substances")
# get the Overall Water Body status of Lakes in the Humber RBD, between
# 2012 and 2014
get_status(ea_name="Humber", column="RBD", startyr=2012, endyr=2014, type="Lake")
# get the Overall Water Body status for Rivers in the Avon Warwickshire
# Operational Catchment in 2011
get_status(ea_name="Avon Warwickshire", column="MC", startyr=2011, type="River")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.