Get rainfall

Get rainfall IDF data.

Usage

get_rainfall(
  sources = NULL,
  location = NULL,
  durations = NULL,
  frequencies = NULL,
  unit = c("lsha", "mm"),
  fields = NULL,
  version = "v0",
  format = c("jsonld", "csv"),
  client = get_frost_client(),
  auth_type = c("basic", "oauth"),
  flatten = TRUE,
  return_response = FALSE
)

Arguments

sources

character: Source (station) ID, e.g. 'SN18700'.

location

character: Geographic position from which to get IDF data, in the following format "POINT(<longitude degrees> <latitude degrees>)".

durations

character: IDF duration(s), in minutes.

frequencies

character: IDF frequencies, in years.

unit

character: Unit of measure for the intensity, either 'mm' or 'lsha'.

fields

character: Fields to return in the response.

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

Examples

if (FALSE) {
df <- get_rainfall()
}