View source: R/get_objectives.r
get_objectives | R Documentation |
Retrieves details of objectives set for waterbodies in terms
of predicted classification 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_objectives( ea_name = NULL, column = NULL, level = "Overall Water Body", year = 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#help-classification-hierarchy. Defaults to 'Overall Water Body'. Possible values for the different levels retrieved by the function are shown below.
| ||||||||||||||||||||||||||||||||||
year |
The year that objectives are set for, either 2015, 2021, 2027, 2040 or 2050. If not given then objectives for all years are returned. Note that objectives may not be set for all years. | ||||||||||||||||||||||||||||||||||
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 details
of the objectives set for the specified set of waterbodies.
For details of the meaning of the the different columns returned,
see https://docs.ropensci.org/cde/articles/cde-output-reference.html.
# get all objectives set for waterbody GB112071065700 get_objectives(ea_name="GB112071065700", column="WBID") # get the objectives set for Lakes in the Humber RBD, for the year 2021 get_objectives(ea_name="Humber", column="RBD", year=2021, type="Lake") # get the objectives set for Rivers in the Avon Warwickshire # Management Catchment in relation to Chemical status get_objectives(ea_name="Avon Warwickshire", column="MC", level="Chemical", type="River")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.