iamCheck: iamCheck

In IAMconsortium/iamc: IAMC Tools

iamCheck

Description

Runs various diagnostics over a provided data set checking whether the provided data is in line with IAMC database guidelines.

Usage

iamCheck(
  x,
  pdf = NULL,
  cfg = "CDLINKS",
  refData = "IAMC",
  verbose = FALSE,
  globalenv = FALSE,
  pdfStyle = NULL,
  ...
)

Arguments

x	Input data that should be checked, provided as a file path to a reporting file, a quitte object or an object which can be converted to quitte using as.quitte
pdf	File name used for a PDF containing diagnostic results of the check. If set to NULL no pdf will be written.
cfg	Project configuration that should be used. Either a project name (currently available: "CDLINKS"), a path to a config file or a data frame specifying available variables and corresponding properties as returned by iamProjectConfig().
refData	Reference data for comparison. Either a project name (currently available: "IAMC"), a path to a mif file or a quitte object containing the data.
verbose	Boolean influencing the degree of information returned by the function. verbose=TRUE returns detailed information whereas verbose=FALSE returns a summary.
globalenv	Boolean deciding whether functions in the global environment should be considered or not.
pdfStyle	list of style-options for the pdf
...	additional data objects which are forwarded to the check functions

Value

List of all inputs and outputs created by the performed checks (invisible)

Author(s)

Jan Philipp Dietrich

See Also

iamProjectConfig, as.quitte, is.quitte

Examples

# run check with example data
iamCheck(example_REMIND, cfg="CDLINKS")

IAMconsortium/iamc documentation built on July 8, 2023, 11:35 p.m.