get_readings: Get readings from measurement stations via the EA API

In DavidASmith/eaflood: Access to the Environment Agency Real Time Flood Monitoring API for England

Get readings from measurement stations via the EA API

Description

Get readings from measurement stations via the EA API

Usage

get_readings(
  measure = NULL,
  station = NULL,
  latest = FALSE,
  today = FALSE,
  start_date = NULL,
  end_date = NULL,
  since = NULL,
  limit = NULL,
  sorted = TRUE
)

Arguments

measure	Return readings only for the given measure URI.
station	Return only readings of measures which are available from the station with the given URI.
latest	Return only the most recently available reading for each included measure.
today	Return all the readings taken today for each included measure.
start_date, end_date	Return the readings taken on the specified range of days for each included measure, up to the specified limit.
since	Return the readings taken since the given date time (not inclusive), up to the specified limit. Will accept a simple date value such as 2016-09-07 which will be interpreted as 2016-09-07T:00:00:00Z.
limit	Return a maximum of these items from the list. By default the readings API endpoints have a limit of 500 items, this can be modified by providing an explicit limit value up to a hard limit of 10000 items.
sorted	Order the array of returned readings into descending order by date, this done before the limits is applied thus enabling you to fetch the most recent n readings.

Value

A data frame of the readings.

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