Skip to contents

Get flood gauge information

Source: R/adapt_hochwasserzentralen.R
hochwasserzentralen_pegel_info.Rd

Get flood gauge information

Usage

hochwasserzentralen_pegel_info(pegelnummer, safe = TRUE, refresh = FALSE)

Arguments

pegelnummer

Pegelnummer identifier (e.g., "HE_24820206").

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 gauge metadata for the selected pegelnummer. 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 flood gauge (pegel) from hochwasserzentralen.de. API documentation: https://bundesapi.github.io/hochwasserzentralen-api/.

See also

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

Examples

if (FALSE) { # \dontrun{
hochwasserzentralen_pegel_info("HE_24820206")
} # }