Generate an HTML report for over-representation analysis results

This function generates an HTML report for over-representation analysis (ORA) results produced by run_ora(). It consumes a structured report_payload object and creates dotplots summarizing enrichment results for each grouping column in the cluster table.

The function is responsible for all visualization and reporting side effects. Statistical analysis is not recomputed. Calling this function implies that an HTML report should be generated; therefore, a valid output directory must be provided.

Usage

create_ora_report(
  report_payload,
  report_info = NULL,
  cluster_hits_report_name = NULL,
  verbose = TRUE,
  report_dir = here::here()
)

Arguments

report_payload

list: A structured ORA report payload as returned by run_ora(). It must contain the raw enrichment results and all metadata required for report generation.

report_info

list | NULL: Optional list with experiment metadata used to annotate the HTML report (e.g., omics data type, project name, analyst, and data description). If NULL, a minimal report is generated.

cluster_hits_report_name

character(1) | NULL: Optional name of the cluster_hits() report that produced the clustering results used for ORA. When provided, it is displayed in the report to document provenance.

verbose

logical(1): Logical flag controlling the display of progress and status messages.

report_dir

character(1): Directory where the HTML report and all associated output files are written. The directory is created if it does not already exist.

Value

A named list of ggplot objects containing the ORA dotplots generated for the report. Each element is named after the corresponding grouping column in the cluster table, allowing easy identification and reuse of the plots outside the HTML report.

See also

run_ora(), cluster_hits(), clusterProfiler::enricher()