Skip to content

Writes a self-contained HTML report for Module 3 topic-model outputs. The report summarizes topic-input caches, model rows, theta separation scores, compact topic-link pass counts, and differential-link summaries when available.

Usage

build_module3_qc_report(
  topic_dir,
  output_dir = file.path(topic_dir, "reports"),
  differential_links_dir = NULL,
  title = "Module 3 QC report",
  top_n = 20L,
  verbose = TRUE
)

Arguments

topic_dir

Module 3 topic output directory.

output_dir

Directory where the report is written. Defaults to `topic_dir/reports`.

Optional Module 3 differential-link directory. If `NULL`, CraftGRN tries to detect a sibling or nested `differential_links` directory.

title

Report title.

top_n

Number of top differential TFs retained per comparison in the QC summary CSV.

verbose

Emit concise progress messages.

Value

Path to the HTML report.