Skip to contents

List Pegel-Online waters

Source: R/adapt_pegel_online.R
pegel_online_waters.Rd

List Pegel-Online waters

Usage

pegel_online_waters(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

params

Named list of query parameters:

includeTimeseries

Include timeseries metadata (TRUE/FALSE).

includeCurrentMeasurement

Include current measurement metadata (TRUE/FALSE).

includeCharacteristicValues

Include characteristic values (TRUE/FALSE).

waters

Filter by water shortnames (character vector).

ids

Filter by station ids (character vector).

timeseries

Timeseries shortname filter (character).

fuzzyId

Fuzzy station id/name search (character).

latitude

Latitude center for geo search (numeric).

longitude

Longitude center for geo search (numeric).

radius

Radius for geo search (numeric).

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 water:

shortname

Water shortname (character).

longname

Water long name (character).

stations

Associated stations (list-column).

timeseries

Associated timeseries metadata (list-column).

Details

Lists waters available in Pegel-Online. API documentation: https://pegel-online.api.bund.dev.

See also

bunddev_parameters() to inspect available query parameters. pegel_online_stations() for station metadata.

Other Pegel Online: pegel_online_measurements(), pegel_online_measurements_plot(), pegel_online_station(), pegel_online_stations(), pegel_online_timeseries()

Examples

if (FALSE) { # \dontrun{
pegel_online_waters(params = list(limit = 5))
} # }