frostr (version 0.2.0)

get_available_qualitycodes: Get metadata on existing quality flags in the "observation" resource

Description

get_available_qualitycodes() returns a data frame with quality flags that describes the quality of an observation. The function requires 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.

Usage

get_available_qualitycodes(client_id,
                           fields = NULL,
                           language = NULL,
                           return_response = FALSE)

Arguments

client_id

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

fields

A character vector. The field to include in the response (i.e. output). If this parameter is set, then only the specified field is returned as a data frame. If not set, then all fields will be returned in the response as a list. The options are NULL (default), "summarized" and "details".

language

A string. The language of the fields in the response. The options are "en-US" (default), "nb-NO" (Norwegian, Bokm<U+00E5>l), and "nn-NO" (Norwegian, Nynorsk).

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 of quality flags, 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 metadata for quality codes
qualitycodes <- get_available_qualitycodes(client_id = frost_client_id)

# Get the summarized metadata for quality codes
summarized_df <- get_available_qualitycodes(client_id = frost_client_id,
                                            fields = "summarized")
# }
# NOT RUN {
# }