Skip to content

Builds a comprehensive HTML report for Module 1 run parameters, input gates, motif-supported canonical support, prediction output integrity, correlation diagnostics, condition-level CraftGRN multiomic input QC, footprint alignment summaries, warning checks, and related QC artifacts. The report can consume a `predict_tfbs()` result, a step-by-step Module 1 result list, or a Module 1 output directory.

Usage

build_module1_qc_report(
  module1,
  omics_data = NULL,
  output_dir = NULL,
  report_name = "module1_qc_report.html",
  scan_predicted_tfbs = TRUE,
  top_n = 20L,
  verbose = TRUE
)

Arguments

module1

Module 1 result list or Module 1 output directory.

omics_data

Optional CraftGRN multiomic object. Used when `module1` is an output directory or does not contain `omics_data`.

output_dir

Directory where the HTML report should be written. If `NULL`, the report is written under `reports` inside the Module 1 output directory when available.

report_name

HTML report filename.

scan_predicted_tfbs

Logical; if `TRUE`, scan predicted TFBS chunks to summarize top TFs and condition support. This is comprehensive but can take extra time on full projects.

top_n

Number of TFs to show in top-TF summaries.

verbose

Emit concise progress messages.

Value

Normalized path to the HTML report.