Skip to content

Available editions of the criteria definitions.

Description

A named list mapping edition date strings to their directory paths within the installed package.

Usage

editions

Format

An object of class list of length 2.

Keyword

datasets

Load criteria definitions.

Description

Loads and returns the criteria definitions contained in the package.

Usage

load_criteria(
  components = NULL,
  load_all = FALSE,
  csv_engine = "read.csv",
  criteria_types = NULL,
  reference_subset = NULL,
  edition = NULL
)

Arguments

  • components: A string or character vector of component names. The return type changes depending on whether a single string or a vector is provided. Available components: "criteria-thresholds", "criteria-descriptions", "criteria-variables", "criteria-types", "reference-data", "reference-metadata", "sources".
  • load_all: Logical. Load all available components. Cannot be combined with components.
  • csv_engine: The method for loading CSV files. One of "read.csv" (default), "readr", or "data.table".
  • criteria_types: Character string or vector. When loading "criteria-thresholds" or "criteria-descriptions", restrict to these criteria types only. Defaults to all types.
  • reference_subset: Character string or vector. When loading "reference-data" or "reference-metadata", restrict to these datasets only. Defaults to all datasets.
  • edition: Character string specifying the edition to load, e.g. "2026-06-01". Defaults to the latest edition.

Value

The loaded data. A data frame or named list for a single component; a named list of those when multiple components are requested.

Examples

df_thresholds <- load_criteria("criteria-thresholds")
print(df_thresholds)

list_metadata <- load_criteria("criteria-descriptions")
print(list_metadata)

criteria <- load_criteria(c("criteria-thresholds", "criteria-descriptions"))
print(criteria[["criteria-descriptions"]])

Scenario Vetting Criteria R-package

Description

Common definitions of vetting criteria for IAM scenarios

Seealso

Useful links:

Author

Philipp C. Verpoort philipp.verpoort@pik-potsdam.de

Keyword

Assessment

Keyword

Climate

Keyword

Criteria

Keyword

Emissions

Keyword

Energy

Keyword

Integrated

Keyword

Land-use

Keyword

Modelling

Keyword

Pathways

Keyword

Scenario

Keyword

Validation

Keyword

Vetting