Render a Population Genomics Report — render

Renders the bundled manuscript-oriented report template as portable HTML, compact PDF, or both.

Usage

render_report(
  results_rds,
  output_dir,
  title = "Population genomics analysis",
  author = "",
  formats = c("html", "pdf"),
  max_concurrent_figures = 100L
)

Arguments

results_rds: Path to a serialized pipeline result object.
output_dir: Report output directory.
title: Report title.
author: Report author.
formats: One or more of html and pdf. Both are produced by default. PDF rendering requires XeLaTeX, LuaLaTeX, or pdfLaTeX. When both formats are requested and LaTeX is unavailable, HTML is still produced and PDF is skipped with a warning. When both formats are requested on a non-Windows platform, they render concurrently in forked worker processes – unless the report has more than max_concurrent_figures embedded figures, in which case they render sequentially instead, to keep peak memory bounded on a very large report. Windows (no fork support) always renders sequentially regardless.
max_concurrent_figures: Figure-count threshold above which concurrent HTML+PDF rendering is disabled in favor of sequential rendering (slower, but with roughly half the peak memory).

Value

Named rendered report paths, invisibly.