Getting Available Datasets

The GeoSphere Austria (formerly ZAMG) datahub API provides an endpoint to get available datasets. This function returns a (possibly pre-filtered) data.frame containing the dataset type, mode and resource_id needed to perform the data requests (see e.g., gs_stationdata()) amongst some additional information.

Usage

gs_datasets(
  type = "station",
  mode = NULL,
  version = 1L,
  config = list(),
  verbose = FALSE
)

Arguments

type

NULL or character of length 1 to filter the request.

mode

NULL or character of length 1 to filter the request. Currently defaults to mode = "station".

version

integer, API version (defaults to 1).

config

empty list by default; can be a named list to be fowrarded to the httr::GET request if needed.

verbose

logical, if set TRUE some more output will be produced.

Value

Returns a data.frame with all available data types and API endpoints. When both type and mode are equal to NULL

all data available via the API will be returned. The most important information of this return is the type, mode, as well as resource_id which is used to perform data requests.

Details

The API provides an enpoint to get all available data sets which can be filtered using the arguments type and/or mode. Classical usecase:

Return all data sets where mode == "historical":

• gs_datasets(mode = "historical")

Return all data sets where type == "grid":

• gs_datasets(type = "grid")

Can be combined (setting both type and mode).

See also

gs_stationdata

Author

Reto Stauffer