esgdict_option() returns valid values for an ESG dictionary field, optionally constrained by other supplied fields.

esgdict_option(field, ..., project = NULL, dict = NULL, warn_ignored = TRUE)

Arguments

field

An ESG dictionary field name or supported alias.

...

Optional field constraints, such as activity_id = "CMIP" or table_id = "day" for CMIP6.

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.

warn_ignored

If TRUE, warn when supplied constraints cannot be used by any available relation index.

Value

A data.table::data.table() with at least field, value, and description columns. The ignored_constraints attribute records constraints that were not used.