catalogue: List of stations from UK NRFA

In cvitolo/rnrfa: UK National River Flow Archive Data from R

Description

This function pulls the list of stations (and related metadata), falling within a given bounding box, from the CEH National River Flow Archive website.

Usage

catalogue(
  bbox = NULL,
  column_name = NULL,
  column_value = NULL,
  min_rec = NULL,
  all = TRUE
)

Arguments

bbox	this is a geographical bounding box (e.g. list(lon_min = -3.82, lon_max = -3.63, lat_min = 52.43, lat_max = 52.52))
column_name	name of column to filter
column_value	string to search in column_name
min_rec	minimum number of recording years
all	if TRUE it returns all the available metadata. If FALSE, it returns only the following columns: id, name, river, hydrometricArea, operator, haName, catchmentArea, altitude, lat, lon.

Details

coordinates of bounding box are required in WGS84 (EPSG: 4326). If BB coordinates are missing, the function returns the list corresponding to the maximum extent of the network.

Value

tibble table containing the list of stations and related metadata

Author(s)

Claudia Vitolo

Examples

## Not run: 
  # Retrieve all the stations in the network
  x <- catalogue()

  # Define a bounding box:
  bbox <- list(lon_min=-3.82, lon_max=-3.63, lat_min=52.43, lat_max=52.52)
  # Get stations within the bounding box
  x <- catalogue(bbox)

  # Get stations based on minimum catchment area
  x <- catalogue(column_name = "catchment-area", column_value = 2000)

  # Get stations based on minimum number of recording years
  x <- catalogue(min_rec=30)

## End(Not run)

cvitolo/rnrfa documentation built on Feb. 16, 2021, 2:39 p.m.