Deterministic publication report rendering contracts — publication_report

Defines backend-independent rendering specifications, manuscript-bound plans, and checksum-verifiable output manifests for publication reports.

Usage

new_publication_report_spec(
  formats = "html",
  style = "generic",
  numbered_sections = TRUE,
  numbered_figures = TRUE,
  bibliography = TRUE,
  supplementary_index = TRUE
)

validate_publication_report_spec(spec)

new_publication_report_plan(
  manuscript,
  spec = new_publication_report_spec(),
  renderer_id = "quarto",
  renderer_version = "unspecified"
)

validate_publication_report_plan(plan, manuscript, spec)

new_publication_report_output_manifest(plan, output_dir, warnings = character())

validate_publication_report_output_manifest(manifest, plan, output_dir)

publication_report_plan_report(plan)

Arguments

formats: Output formats selected from html, pdf, and docx.
style: Stable rendering style identifier.
numbered_sections: Whether report sections are numbered.
numbered_figures: Whether figures and tables are numbered.
bibliography: Whether bibliography rendering is required.
supplementary_index: Whether a supplementary-material index is required.
spec: A publication report specification.
manuscript: A validated PopgenVCFManuscript.
renderer_id: Stable renderer or backend identity.
renderer_version: Stable renderer version.
plan: A publication report rendering plan.
output_dir: Directory containing rendered outputs.
warnings: Stable renderer warning messages.
manifest: A rendered-output manifest.

Value

Constructors return deterministic fingerprinted records. Validators return TRUE invisibly. publication_report_plan_report() returns Markdown lines.