getStationList API call to Kisters KiWIS API

This is the API used by Australian Bureau of Meteorology and many others. For consistency with similar state functions using Kisters Hydstra, I have kept the station_no argument with the same name. Any of the return fields can be searched though, using extra_list. The equivalent state (Hydstra) function is get_db_info() (to a close approximation).

Usage

getStationList(
  portal,
  station_no = NULL,
  returnfields = "default",
  extra_list = list(NULL)
)

Arguments

portal

URL to Kisters KiWIS database.

station_no

gauge numbers, as site_list in the Hydstra functions. There are many other fields that can be used to filter and select records, but this seems to be most common and so we give it special treatment. For others, use see extra_list

returnfields

default 'default', otherwise 'all' to get everything available, or comma-separated string of fields to return. Important- 'coverage' is required to return start and end dates. It is included by default. Including 'ca_sta' will give the DATA_OWNER_NAME, which is often useful. Full list for each function available from Kisters docs

extra_list

a named list of other fields to select on. Names (usually) should be in returnfields (or returned when returnfields = 'all'), though not all work- see the queryfields in the Kisters docs. Values should be comma-separated characters, and can contain grep wildcards e.g. extra_list = list(station_name = 'RIVER MURRAY*). Can also use groups from getGroupList(), e.g. extra_list = list(stationgroup_id = '20017550') gets the MDB_WIP_Watercourse stations.

Value

a tibble