Render a parameterized clinical report (PDF / DOCX / HTML)

Renders a one-page, bilingual, colorblind-safe clinical report for a gait, HRV or EMG assessment. PDF and HTML are produced from a parameterized Quarto template (quarto + the Quarto CLI); DOCX is produced by an editable officer path that needs no LaTeX toolchain (buildDocxReport).

Usage

renderClinicalReport(
  data,
  template = c("gait", "hrv", "emg"),
  format = c("pdf", "docx", "html"),
  lang = c("en", "ja"),
  out = NULL
)

Arguments

data

A report payload list. Recognized elements: subject (a label), figures (a named list of ggplot panels — build them with the colorblind-safe primitives, e.g. plotNormativeBand / clinicalGaitReport), change (an optional annotateChange result rendered as an MDC/MCID table) and provenance (an optional named list for the footer, e.g. from metadata(pe)).

template

Report template: "gait" (default), "hrv" or "emg".

format

Output format: "pdf" (default), "docx" or "html".

lang

"en" (default) or "ja"; drives the localized headings via physioLabel.

out

Output file path; defaults to a temp file named for the template and format.

Value

The output path, invisibly.

See also

buildDocxReport(), clinicalGaitReport(), annotateChange()

Examples

# The LaTeX-free docx path needs only officer (a Suggests dependency); the
# pdf / html paths additionally need the quarto package and the Quarto CLI.
if (requireNamespace("officer", quietly = TRUE)) {
  fig <- plotNormativeBand(NULL,
    NormativeModel(sin(seq(0, pi, length.out = 101)), rep(0.1, 101), time = 0:100))
  renderClinicalReport(list(subject = "P01", figures = list(gait_cycle = fig)),
                       template = "gait", format = "docx", lang = "ja")
}