List MUDAB parameters (Sediment)
Usage
mudab_parameters_sediment(
filter = NULL,
range = NULL,
orderby = NULL,
safe = TRUE,
refresh = FALSE
)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 totools::R_user_dir("bunddev", "cache").- refresh
Logical; if
TRUE, ignore cached responses and re-fetch from the API (defaultFALSE).
Value
A tibble with one row per parameter and columns:
- metadataid
Integer. Metadata identifier.
- COMPT_DS
Character. Compartment code (BL, CW, CS, or CF).
- PARAMETER
Character. Parameter abbreviation.
- PARAMETERGRUPPE
Character. Parameter group code.
- PARAM_NAME
Character. Parameter name.
- PARGROUP
Character. Parameter group code (alternate).
- PARAMGROUP_NAME
Character. Parameter group name.
Details
Returns parameter entries for the Sediment compartment. API documentation: https://mudab.api.bund.dev.
Examples
if (FALSE) { # \dontrun{
mudab_parameters_sediment(range = list(from = 0, count = 5))
} # }