report.write_quarto_report

report.write_quarto_report(
    outdir,
    result=None,
    *,
    title='FALCONAge report',
    logo=None,
    registry=None,
    render=False,
)

Write falconage_report.qmd into a run’s output directory; render it if asked.

Every file in outdir is placed under the step of the analysis that produced it (:mod:falconage.report.outputs), in step order, with its description: tables collapsible, searchable and downloadable as CSV, figures zoomable and downloadable at full resolution. A file the output table does not name is listed in the last step, so nothing in the directory is left out. Rendering embeds every figure and table, so the HTML is one file that references nothing.

result, when given, adds what each scored category of clock means to the scores step. render=True runs quarto render and returns the HTML path; it raises if Quarto is not on the path, naming the source to render elsewhere. Otherwise the .qmd path is returned.