orm_report: Generate all ORISMA outputs and reports

View source: R/orm_report.R

orm_reportR Documentation

Generate all ORISMA outputs and reports

Description

orm_report() takes a completed orisma_result object and generates the full set of outputs including improved visualisations and a rich bilingual HTML executive report.

Usage

orm_report(
  result,
  topic = NULL,
  lang = getOption("orisma.lang", "en"),
  out_dir = getOption("orisma.out_dir", "orisma_output"),
  formats = c("html", "csv", "plots", "certificate"),
  min_records = 1L,
  top_n = 8L,
  verbose = getOption("orisma.verbose", TRUE)
)

Arguments

result

An orisma_result object from orm_analyse() or orm_run().

topic

Character. Domain or technology being analysed. Used in plot subtitles and report headers. If NULL, neutral generic text is used.

lang

Character. "en" or "es". Report language.

out_dir

Character. Output directory. Created if it does not exist.

formats

Character vector. Which outputs to generate. Options: "html", "csv", "plots", "certificate". Default: all.

min_records

Integer. Minimum records for a category to appear in plots. Default 1.

top_n

Integer. Number of top categories to show in temporal plot. Default 8.

verbose

Logical. Print progress?

Value

Invisibly returns the output directory path.


orisma documentation built on May 19, 2026, 1:07 a.m.