Check ESG Dictionary Parameter Values — esgdict

esgdict_check() validates project parameter values against the local ESG dictionary. It checks individual field values and cross-field relationships represented in the dictionary's normalized query indices.

esgdict_check(
  ...,
  project = NULL,
  dict = NULL,
  error = FALSE,
  suggest = TRUE,
  n_suggestions = 5L,
  relationship = c("any", "all_pairs")
)

Arguments

...: ESG dictionary field values.
project: ESG project identifier. If NULL, the project is inferred from dict when supplied, otherwise "CMIP6" is used.
dict: Optional EsgDict object. If NULL, the package-level default dictionary for project is used when available; otherwise the project default dictionary is loaded from the persistent store manifest.
error: If TRUE, throw an error when invalid values or relationships are found.
suggest: If TRUE, include near-match suggestions for invalid values.
n_suggestions: Maximum number of suggestions to keep for each invalid value.
relationship: Relationship validation mode. "any" validates ESGF-query style OR semantics. "all_pairs" requires every supplied combination inside each relation index to exist.

Value

An esgdict_check_result data.table::data.table().