get_sources {frostr}

Get metadata for source entities defined in the Frost API

Description

get_sources() retrieves metadata about (data) source entities defined for use in the Frost API. The function requires an input for client_id. The other function arguments are optional, and default to NULL, which means that the response from the API is not filtered on these parameters.

NB: At the time of writing (2019-06-08), the Frost API "sources" resource only returns country names in Norwegian.

Usage

get_sources(client_id,
            ids = NULL,
            types = NULL,
            geometry = NULL,
            nearest_max_count = NULL,
            valid_time = NULL,
            name = NULL,
            country = NULL,
            county = NULL,
            municipality = NULL,
            wmo_id = NULL,
            station_holder = NULL,
            external_ids = NULL,
            icao_code = NULL,
            ship_code = NULL,
            wigos_id = NULL,
            fields = NULL,
            return_response = FALSE)

Arguments

client_id

A string. The client ID to use to send requests to the Frost API.

ids

A character vector. The Frost API source ID(s) that you want metadata for.

types

A string. The type of Frost API source that you want metadata for. Must be set to either "SensorSystem", "InterpolatedDataset", or "RegionDataset". Defaults to NULL, which returns all three types.

geometry

A string. Get Frost API sources defined by a specified geometry. Geometries are specified as either "nearest(POINT(...))" or "POLYGON(...)" using well-known text representation for geometry (WKT).

nearest_max_count

A string. The maximum number of sources returned when using "nearest(POINT(...))" for the geometry argument. Defaults to 1.

valid_time

A string. The time interval for which the sources have been, or still are, valid (or applicable). Specify as "<date>/<date>" or "<date>/now" where <date> is a date in the ISO-8601 format (YYYY-MM-DD). Defaults to "now" if not specified, which returns only currently valid sources.

name

A string. The data source name to get metadata for.

country

A string. The country name or country code to get metadata for.

county

A string. The county name or county ID to get metadata for.

municipality

A string. The municipality to get metadata for.

wmo_id

A string. The WMO ID to get metadata for.

station_holder

A string. The station holder name to get metadata for.

external_ids

A character vector. The external ID to get metadata for.

icao_code

A string. The ICAO code to get metadata for.

ship_code

A string. The ship code to get metadata for.

wigos_id

A string. The WIGOS ID to get metadata for.

fields

A character vector. Fields to include in the response (i.e. output). If this parameter is specified, then only these fields are returned in the response. If not specified, then all fields will be returned in the response.

return_response

A logical. If set to TRUE, then the function returns the response from the GET request. If set to FALSE (default), then the function returns a tibble (data frame) of the content in the response.

Value

The function returns either a data frame with metadata about source entities, or the response of the GET request, depending on the boolean value set for return_response.

Examples

## Not run: 
frost_client_id <- "<YOUR FROST CLIENT ID>"

# Get data for all sources
sources <- get_sources(client_id = frost_client_id)

# Get data for sources in Norway
sources_norway <- get_sources(client_id = frost_client_id,
                              country   = "NO")

## End(Not run)