Get elements — get_elements • frostr2

Get metadata about the weather and climate elements.

Usage

get_elements(
  ids = NULL,
  names = NULL,
  descriptions = NULL,
  units = NULL,
  code_tables = NULL,
  statuses = NULL,
  calculation_method = NULL,
  categories = NULL,
  time_offsets = NULL,
  sensor_levels = NULL,
  cf_standard_names = NULL,
  cf_cell_methods = NULL,
  cf_units = NULL,
  cf_versions = NULL,
  fields = NULL,
  lang = c("en-US", "nb-NO", "nn-NO"),
  version = "v0",
  format = c("jsonld"),
  client = get_frost_client(),
  auth_type = c("basic", "oauth"),
  flatten = TRUE,
  return_response = FALSE
)

Arguments

ids: character: Source ID(s).
names: character: Location name(s)
descriptions: character: Descriptions
units: character: Units
code_tables: character: Code tables
statuses: character: Statuses
calculation_method: character: Calculation method
categories: character: Categories
time_offsets: character: The time offsets to get observations for, specified as ISO-8601 periods.
sensor_levels: character: Sensor levels
cf_standard_names: character: CF standard names
cf_cell_methods: character: CF cell methods
cf_units: character: CF units
cf_versions: character: CF versions
fields: character: Fields to return in the response.
lang: character: ISO language/locale to be used for search filters and return values
version: character: API version.
format: character: Response format.
client: list: List with client id and secret. Defaults to the `MET_FROST_ID` and `MET_FROST_SECRET` environment variables.
auth_type: character: Authentication method, either 'basic' or 'oauth'.
flatten: logical: If TRUE the response is transformed to a table.
return_response: logical: If TRUE a list of class `frost_api` is returned, including the raw `httr2_response`.

Value

tibble or list

Details

Use the default query parameters to retrieve all elements.

Examples

if (FALSE) {
# Get all elements
df <- get_elements()
}