R/get_winfapapi.R
get_amax.RdThe function queries the NRFA API for the .AM file similar to the WINFAP file for a given stations. It then processes the file in a fashion similar to read_amax.
get_amax(station)the NRFA station number for which the annual maxima records should be obtained. Can also be a vector of station numbers.
a data.frame with information on the annual maxima for the station with the following columns
NRFA station number (can be a vector of station numbers)
the correct water year for the peak flow
date of maximum flow
the maximum flow in m3/s
the stage (height) reached by the river - this information is used to derive the flow via a rating curve
logical, if TRUE the water year has been flagged as rejected by the NRFA
read_amax. Information on river flow gauging in the UK and the annual maxima can be found at the National River Flow Archive website https://nrfa.ceh.ac.uk
a40003 <- get_amax(40003) # the Medway at Teston / East Farleigh
multipleStations <- get_amax(c(40003, 42003))
names(multipleStations)
#> [1] "40003" "42003"
summary(multipleStations$`42003`)
#> Station WaterYear Date Flow
#> Min. :42003 Min. :1975 Min. :1976-09-30 Min. : 4.16
#> 1st Qu.:42003 1st Qu.:1986 1st Qu.:1987-05-30 1st Qu.:15.68
#> Median :42003 Median :1998 Median :1998-10-24 Median :20.20
#> Mean :42003 Mean :1998 Mean :1999-01-17 Mean :23.66
#> 3rd Qu.:42003 3rd Qu.:2010 3rd Qu.:2010-07-18 3rd Qu.:27.55
#> Max. :42003 Max. :2021 Max. :2021-10-21 Max. :80.83
#> Stage Rejected
#> Min. :-9999.000 Mode :logical
#> 1st Qu.: 1.240 FALSE:27
#> Median : 1.380 TRUE :20
#> Mean :-1487.957
#> 3rd Qu.: 1.615
#> Max. : 2.131