get_monthly: Get quality-checked timeseries data

In a-buz/bomWater: Download Australian Bureau of Meteorology Water Data

Description

This function returns a quality-checked timeseries from Water Data Online.

Usage

get_monthly(
  parameter_type,
  station_number,
  start_date,
  end_date,
  tz,
  return_fields
)

Arguments

parameter_type	The water data parameter type (e.g. Water Course Discharge). See parameters() for a full list.
station_number	The AWRC station number.
start_date	Start date formatted as a string or date class (YYYY-MM-DD).
end_date	End date formatted as a string or date class (YYYY-MM-DD).
tz	Optional: the desired time zone for the output timeseries. Input must be an Olson Name (see OlsonNames()). By default the timeseries are returned in non-DST time zones (AEST, ACST or AWST) depending on the station location.
return_fields	Optional: columns to be returned from Water Data Online. By default Timestamp, Value and Quality Code are returned.

Details

For the parameters (and their units) that can be requested, see parameters. More information can be found in the Water Data Online SOS manual (URL in See Also below).

Common valid return fields are:

• Timestamp

• Value

• Quality Code

• Interpolation Type

Other valid return fields (depending on the parameter requested) may be:

• Absolute Value

• AV Interpolation

• AV Quality Code

• Runoff Value

• RV Interpolation

• RV Quality Code

• Aggregation

• Accuracy

If the request is not valid it will fail.

Value

A tibble with the requested return fields, which by default are Timestamp, Value and Quality Code. Zero row tibbles are returned if no data is available for the requested dates. The aggregation of data is generally the mean for most variables, except for rainfall and evaporation which is the sum over the chosen period.

Author(s)

Alexander Buzacott

See Also

• http://www.bom.gov.au/waterdata/

• BoM Guide to Sensor Observation Services (SOS2) for Water Data Online

Examples

# Monthly average dry air temperature at Corin Dam
## Not run: 
get_monthly(
  parameter_type = "Dry Air Temperature",
  station_number = "570947",
  start_date = "2016-01-01",
  end_date = "2016-06-01"
)

## End(Not run)

a-buz/bomWater documentation built on Sept. 3, 2021, 8:21 a.m.