get_parameter_list: Retrieve available parameters for stations

Description Usage Arguments Details Value Examples

View source: R/bomWater.R

Description

get_parameter_list returns the parameters that can be retrieved at one or more stations.

Usage

1
get_parameter_list(station_number, return_fields)

Arguments

station_number

A single or multiple vector of AWRC station numbers.

return_fields

(Optional) Station parameter details to be returned. By default the return fields are: station_no, station_id, station_name, parametertype_id, parametertype_name, parametertype_unitname parametertype_shortunitname.

Details

The default return fields have been selected to generally return the most useful fields while reducing duplication of metadata. The full list of return fields:

Value

A tibble with columns for each of the return fields.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Return parameters for a single station
## Not run: 
get_parameter_list(station_number = "410730")

## End(Not run)
# Return available parameters for multiple stations
## Not run: 
get_parameter_list(station_number = c("410730", "570946"))

## End(Not run)

bomWater documentation built on Sept. 16, 2020, 9:07 a.m.