Exporting a value with label and potential description for reporting

IQRoutputValueTable.Rd

Single values or elements can be pushed to a table that can be used to store values of interest during the analysis. Upon call of this function the path (path argument) an rds file is generated with the provided label, value, and description content. If compliance mode is on also the compliance information is stored. In addition all similar files are read in and a table is constructed and exported in the text based format used by IQReport. This table is then useful when reporting results inline in IQReport. The path to the value table information can be chosen. A default is provided. The name of the resulting table text file is fixed to TAB01_ValueTable.txt as there can only be one such file per value table folder.

IQRoutputValueTable(
  value,
  label,
  description = "",
  path = "../Output/00_ValueTable"
)

Arguments

value: A single value (numeric or string) to report in the table.
label: A label allowing to reference the element. Only characters A-Z, a-z, 0-9 are allowed.
description: More wordy description of the element. Default: "".
path: Path to the folder in which to store the value table elements and where to generate the value table text file for reporting.

Other Output: IQRinitCompliance(), IQRoutputCSV(), IQRoutputDEFINE(), IQRoutputFigure(), IQRoutputFile(), IQRoutputPDF(), IQRoutputPDFParallel(), IQRoutputPDFend(), IQRoutputPDFstart(), IQRoutputPNG(), IQRoutputRDS(), IQRoutputTable(), IQRoutputXPT(), createSubmissionPack(), getModelSpecification(), getProgramSpecification(), import_IQRdataOriginal(), is_enabled_complianceMode(), is_enabled_rdsMode(), packageR_IQRtools(), print.IQRoutputTable(), read_IQRoutputTable(), text_IQRoutputTable()

Exporting a value with label and potential description for reporting

Arguments

See also