Skip to contents

List MUDAB project stations

Usage

mudab_project_stations(
  filter = NULL,
  range = NULL,
  orderby = NULL,
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

filter

Optional filter definition.

range

Optional range specification.

orderby

Optional ordering specification.

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 project station and columns:

metadataid

Integer. Metadata identifier.

PROJECTSTATIONID

Integer. Project station identifier.

NAME_PS

Character. Project station name.

REGION

Character. Region of the station.

INSTITUT

Character. Responsible institute.

Details

Returns project stations from the MUDAB database. API documentation: https://mudab.api.bund.dev.

Examples

if (FALSE) { # \dontrun{
mudab_project_stations(range = list(from = 0, count = 5))
} # }