orm_run: Run the complete ORISMA pipeline in one call

View source: R/orm_run.R

orm_runR Documentation

Run the complete ORISMA pipeline in one call

Description

orm_run() is the single-function entry point for a complete ORISMA analysis. It runs all pipeline steps automatically:

  1. Deduplication (3-step: DOI + title + fuzzy)

  2. Risk category extraction (dictionary-based)

  3. Bibliometric analysis (WRDI, RCS, MGP indicators)

  4. Automatic dimension detection (normative blocks)

  5. Abstract Sufficiency Score (ASS, 0-5)

  6. Bridge article detection and priority ranking

Minimal usage (3 lines)

library(orisma)
refs   <- orm_load("my_references/")
result <- orm_run(refs)
orm_report(result, lang = "es")

All intermediate objects are stored in the result for downstream use with orm_report(), orm_risk_sheet(), orm_ranking(), and orm_extraction_matrix().

Usage

orm_run(
  refs,
  dict = orm_dict(),
  topic = NULL,
  autodim_method = "blocks",
  material_col = NULL,
  year_col = "year",
  fuzzy_threshold = 0.9,
  fields = c("title", "abstract", "keywords"),
  lang = getOption("orisma.lang", "en"),
  verbose = getOption("orisma.verbose", TRUE),
  save_report = FALSE,
  out_dir = getOption("orisma.out_dir", "orisma_output")
)

Arguments

refs

An orisma_refs object from orm_load().

dict

An orisma_dict object. Default: orm_dict().

topic

Character. Domain or technology being analysed (e.g. 'Noise in construction', 'Metal AM'). Used in plot subtitles and report headers. If NULL, neutral generic text is used.

autodim_method

Character. "blocks" (default) or "text".

material_col

Character or NULL. Column for MGP. Default NULL.

year_col

Character. Year column. Default "year".

fuzzy_threshold

Numeric. Deduplication threshold. Default 0.90.

fields

Character vector. Text fields for extraction. Default c("title", "abstract", "keywords").

lang

Character. "en" or "es".

verbose

Logical. Default TRUE.

save_report

Logical. Auto-call orm_report()? Default FALSE.

out_dir

Character. Output directory if save_report = TRUE.

Value

An orisma_result object containing all indicators, analyses, dimensions (result$dims), extraction matrix (result$mx), ASS scores and bridge classification (in result$mx$refs), and priority ranking (result$ranking).


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