Skip to contents

Render a single-gene characterization report

Source: R/gene_report.R
gene_report.Rd

Renders the parameterized `gene-report.qmd` vignette for a specific gene, producing a self-contained HTML report with expression distribution, survival stratification, cytogenetic context, and gene-gene correlations.

Usage

gene_report(
  gene,
  output_dir = "results/gene_reports",
  vst_matrix = NULL,
  surv_data = NULL,
  cyto_data = NULL
)

Arguments

gene

Gene name (e.g., "CD70", "TP53")

output_dir

Directory for the rendered report (default "results/gene_reports/")

vst_matrix

Optional pre-loaded VST matrix (genes x samples). If NULL, the function attempts to load from the targets store.

surv_data

Optional pre-loaded survival data frame. If NULL, attempts to load from the targets store.

cyto_data

Optional pre-loaded cytogenetic data frame

Value

Path to the rendered HTML file (invisibly)

See also

Other utilities: create_summary_table(), example_data(), export_h5ad(), format_file_size(), format_with_commas(), strip_plotly()

Examples

if (FALSE) { # \dontrun{
gene_report("CD70")
gene_report("TP53", output_dir = "results/")
} # }