SWTools (version 1.1.0)

HydstraSiteDetails: Get streamflow station information from Hydstra API

Description

This function use the API associated with states' Hydstra databases to return useful site information.

Usage

HydstraSiteDetails(site, state, out_folder, flood_level = NA)

Value

a vector of length 3, with the number of cross sections, rating curves and streamflow gaugings found, respectively.

Arguments

site

station number, e.g. "425018"

state

relevant state database foro the station, e.g. "NSW"

out_folder

path to folder to save outputs

flood_level

optional, water level in stage datum to plot on the cross section data

Details

Currently, the relevant websites are useful for site discovery:

• https://water-monitoring.information.qld.gov.au

• https://realtimedata.waternsw.com.au

• https://data.water.vic.gov.au/WMIS

The Bureau of Meteorology's Water Data Online site is also useful, which can also be queried using get_station_list() from BomWater package.

The function will save a number of files to out_folder that have a file name starting with the station number followed by:

• site_info.csv: general site information returned, e.g. site name, coordinates, length of record, elevation

• x_sec.csv: chainage chain and elevation (rl in gauge datum) of the control section

• rating.csv: current rating curve, the discharge (vf in ML/d) for a gauge height vf, and also as above the cease to flow level (above_ctf)

• gaugings.csv: record of streamflow gaugings available

• discharge.csv: daily time series of streamflow, over a 9am - 9am period

• plot.png: summary plot of the above data

Quality codes shown on the plot are those used by the Bureau of Meteorology defined here

Examples

if (FALSE) {
HydstraSiteDetails("425018","NSW","c:/Temp")
}