Skip to contents

Get flood portal metadata for a Bundesland

Source: R/adapt_hochwasserzentralen.R
hochwasserzentralen_bundesland_info.Rd

Get flood portal metadata for a Bundesland

Usage

hochwasserzentralen_bundesland_info(
  bundesland_id,
  safe = TRUE,
  refresh = FALSE
)

Arguments

bundesland_id

Bundesland id (e.g., "HE").

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).

Value

A one-row tibble of metadata for the selected Bundesland id. Columns are created dynamically from the upstream service response fields. If the response contains GeoJSON features, each feature's properties are used as columns; otherwise each top-level field becomes a column. Scalar values become atomic columns and nested structures become list-columns.

Details

Returns metadata for a single Bundesland or region in the hochwasserzentralen.de portal. API documentation: https://bundesapi.github.io/hochwasserzentralen-api/.

See also

Other Hochwasserzentralen: hochwasserzentralen_bundeslaender(), hochwasserzentralen_bundesland_geojson(), hochwasserzentralen_lagepegel(), hochwasserzentralen_pegel_info()

Examples

if (FALSE) { # \dontrun{
hochwasserzentralen_bundesland_info("HE")
} # }