kiwisR (version 0.2.4)

ki_station_list: Get tibble containing station information.

Description

Returns all available stations by default and allows for search terms and other filters.

Usage

ki_station_list(
  hub,
  search_term,
  bounding_box,
  group_id,
  return_fields,
  datasource = 0
)

Value

Tibble containing station metadata.

Arguments

hub

The KiWIS database you are querying. Either one of the defaults or a URL. See README.

search_term

(Optional) A station name to search for. Supports the use of * as a wildcard. Case doesn't matter.

bounding_box

(Optional) A bounding box to search within for stations. Should be a vector or comma separated string.

group_id

(Optional) A station group id (see ki_group_list). with the following format: (min_x, min_y, max_x, max_y).

return_fields

(Optional) Specific fields to return. Consult your KiWIS hub services documentation for available options. Should be a comma separate string or a vector.

datasource

(Optional) The data source to be used, defaults to 0.

Examples

if (FALSE) {
ki_station_list(hub = "swmc")
ki_station_list(hub = "swmc", search_term = "A*")
ki_station_list(hub = "swmc", bounding_box = "-131.7,-5.4,135.8,75.8")
ki_station_list(hub = "swmc", group_id = "518247")
}