bomWater (version 0.4.1)

get_parameter_list: Retrieve available parameters for stations

Description

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

Usage

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.

Value

A tibble with columns for each of the return fields.

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:

• station_no',

• station_id

• station_name

• stationparameter_id

• stationparameter_no

• stationparameter_name

• stationparameter_longname

• site_id

• site_no

• site_name

• parametertype_id

• parametertype_name

• parametertype_longname

• parametertype_unitname

• parametertype_shortunitname

Examples

# NOT RUN {
# Return parameters for a single station
# }
# NOT RUN {
get_parameter_list(station_number = "410730")
# }
# NOT RUN {
# Return available parameters for multiple stations
# }
# NOT RUN {
get_parameter_list(station_number = c("410730", "570946"))
# }