validationpdf: Create a validation PDF file

View source: R/validationpdf.R

validationpdfR Documentation

Create a validation PDF file

Description

Create a validation PDF file

Usage

validationpdf(
  x,
  hist,
  file = "validation.pdf",
  style = "comparison",
  only_historical = FALSE,
  digits = 3,
  filter = NULL,
  prefix = NULL,
  hideEmptySection = FALSE,
  show_stats = TRUE,
  debug = getOption("debug"),
  pdfStyle = NULL
)

Arguments

x

Data to be validated. All formats allowed which can be converted to quitte (including characters containing the path to a mif or rds file)

hist

Validation data.All formats allowed which can be converted to quitte (including characters containing the path to a mif or rds file)

file

file name of the output PDF 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

style

data style for the returned data. Currently available: "trafficlight", "detailed", "comparison"

only_historical

boolean deciding whether only historical data should be used for validation or also projections from other sources

digits

integer indicating the number of digits to be shown.

filter

Additional filter to be applied on the data to only plot a subset of the provided data

prefix

Prefix which will be put in front of each part title (useful if validation is integrated into a bigger document)

hideEmptySection

removes sections in output file which would be empty for the reason that variables in input 'x' has have correspondance in the hist file

show_stats

boolean specifying whether additional statistic section should show up or not

debug

Switch to activate or deactivate debug mode.

pdfStyle

list of style-options for the pdf

Author(s)

Jan Philipp Dietrich


pik-piam/mip documentation built on April 5, 2024, 12:31 p.m.