iamSummaryPDF: iamSummaryPDF

View source: R/iamSummaryPDF.R

iamSummaryPDFR Documentation

iamSummaryPDF

Description

Creates a PDF summarizing check results and adding additional results for a comparison to reference data (e.g. matching to historical data)

Usage

iamSummaryPDF(
  input,
  check_results = NULL,
  file = "summary.pdf",
  maxLinesOutput = 200,
  pdfStyle = NULL,
  ...
)

Arguments

input

named list with elements available for check functions

check_results

list with check results as returned by iamCheck

file

File name the summary should be written to or a Sweave object. If a sweave object is provided the function will return the updated object, otherwise it will write its content to the file.

maxLinesOutput

maximum number of lines that should be output in the pdf

pdfStyle

list of style-options for the pdf

...

additional arguments sent to swclose

Author(s)

Jan Philipp Dietrich

See Also

iamCheck, iamProjectConfig

Examples

## Not run: 
input <- list(x=example_REMIND, ref=iamReferenceData())
check_results <- iamCheck(example_REMIND)

iamSummaryPDF(check_results$input, check_results$out)

## End(Not run)

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