Skip to contents

Assemble a laboratory report without recalculating analytical values

Usage

cr_lab_report(
  experiment = NULL,
  spec = cr_report_spec(),
  qc = NULL,
  result_graphic = FALSE,
  include_audit_appendix = NULL,
  strict = TRUE,
  style = NULL,
  profile = NULL
)

Arguments

experiment

Optional validated cr_experiment; it is retained by reference semantics of ordinary R lists and never modified.

spec

A cr_report_spec.

qc

Optional concise QC table from cr_report_qc().

result_graphic

Optional precomputed plot, or TRUE to build one from result thresholds when possible.

include_audit_appendix

Include a compact audit appendix in the rendered document.

strict

Apply strict specification validation.

style

A cr_report_style() shared by the document and its embedded report figures. Legacy cr_plot_style objects are converted.

profile

Optional cr_report_profile() containing laboratory defaults, labels, required fields, and organization-wide visual settings.

Value

A cr_lab_report object holding the validated specification, the QC table, the report style and audit events. No analytical values are recalculated.

Examples

spec <- cr_report_spec(
  report = list(report_id = "EXAMPLE-001"),
  result = list(value = 1.42, unit = "a.u.", classification = "INTERMEDIATE"),
  authorization = list(authorized_by = "Example Authorizer")
)
qc <- cr_report_qc("Cells per well", observed = "1520",
                   acceptance = ">= 500", status = "PASS")
report <- cr_lab_report(spec = spec, qc = qc)
report
#> <cr_lab_report>
#>   Report: EXAMPLE-001 version 1.0 [ DRAFT ]
#>   QC rows: 1