Fetch DWD coastal warnings

Fetch DWD coastal warnings

Usage

dwd_coast_warnings(
  language = c("de", "en"),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

language

Language code ("de" or "en").

safe

Logical; if TRUE (default), apply rate-limiting and cache GET responses to tools::R_user_dir("bunddev", "cache").

refresh

Logical; if TRUE, ignore cached responses and re-fetch from the API (default FALSE).

flatten

Logical; if TRUE, simplify nested list columns according to flatten_mode. Default FALSE keeps list columns as-is.

flatten_mode

How to handle list columns when flatten = TRUE:

"drop"

Remove list columns entirely. Use when nested data is not needed.

"json"

Convert each list element to a JSON string. Preserves all data in a text-queryable format. This is the default.

"unnest"

Expand list columns into multiple rows via tidyr::unnest_longer(). Warning: this can significantly increase the number of rows.

Value

A tibble with one row per coastal warning:

region_id

Warning region identifier (character).

type

Warning type code (numeric).

level

Warning severity level (numeric).

description

Warning description HTML (character).

description_text

Warning description plain text (character).

event

Event name (character).

headline

Warning headline (character).

Details

Retrieves coastal warnings from the DWD App API. API documentation: https://dwd.api.bund.dev.

See also

dwd_warnings_nowcast() and dwd_municipality_warnings().

Other DWD: dwd_alpine_forecast_text(), dwd_avalanche_warnings(), dwd_crowd_reports(), dwd_municipality_warnings(), dwd_sea_warning_text(), dwd_station_overview(), dwd_warnings_nowcast()

Examples

if (FALSE) { # \dontrun{
dwd_coast_warnings(language = "de", flatten = TRUE)
} # }