export_results: Export Analysis Results

View source: R/io.R

export_resultsR Documentation

Export Analysis Results

Description

Exports analysis results to Excel and/or CSV format.

Usage

export_results(results, output_dir, format = "xlsx", verbose = TRUE)

Arguments

results

Named list containing analysis results. Expected components include: hurdle, te, te_by_type (list with counts/rates/binary), placebo, tvarstar, varx, eba, dbn_arcs, hmm, sensemakr_I, sensemakr_C, oos, ate.

output_dir

Directory path for output files. Created if it does not exist.

format

Character; output format. One of "xlsx", "csv", or "both".

verbose

Logical; if TRUE, print progress messages.

Value

Invisible path to output directory.

Examples

results <- list(
  hurdle = data.frame(model = "test", elpd = -100),
  te = data.frame(dir = "I->C", stat = 0.5, p_value = 0.01)
)

# CSV export uses only imported packages and always works:
export_results(results, tempdir(), format = "csv", verbose = FALSE)

# Excel export additionally requires the 'openxlsx' package:
if (requireNamespace("openxlsx", quietly = TRUE)) {
  export_results(results, tempdir(), format = "xlsx", verbose = FALSE)
}

bivarhr documentation built on July 7, 2026, 1:06 a.m.