Skip to contents

Write a Quarto report for a theory

Source: R/report_render.R
tf_render_report.Rd

Writes a standalone Quarto report to path (forced to a .qmd suffix): a YAML header (title, format) followed by the deterministic tf_dossier(theory) body. Returns the written path. When render = TRUE, invokes quarto render, which requires a Quarto installation.

Usage

tf_render_report(theory, path, title = NULL, render = FALSE, to = "html")

Arguments

theory

A theory object (named list), e.g. from tf_read().

path

Destination path; any extension is replaced with .qmd.

title

Optional report title; defaults to "theoryforge report: <title-or-id>". Double quotes are escaped.

render

When TRUE, run quarto render on the written file.

to

Quarto output format (default "html").

Value

The path of the written .qmd file.

Examples

theory <- tf_theory("demo-1", "A demonstration theory") |>
  tf_add_construct("c_arousal", "Arousal", "Bodily activation.")
path <- tempfile(fileext = ".qmd")
tf_render_report(theory, path)
#> [1] "/tmp/RtmpIjBU1m/file1a763bb85d91.qmd"