Skip to contents

Write a reproducible summary of a multiverse

Source: R/report.R
report_multiverse.Rd

report_multiverse() computes the vibration-of-effects summary, saves a specification curve and a vibration-of-effects volcano, and writes the summary to a CSV file. It is a convenience wrapper around voe(), spec_curve(), and voe_volcano() for producing shareable artifacts.

Usage

report_multiverse(
  results,
  dir = ".",
  prefix = "multiverse",
  estimate = estimate,
  p_value = p.value
)

Arguments

results

A tibble of per-specification results, for example from fit_multiverse().

dir

Output directory. Created if it does not exist.

prefix

File-name prefix for the outputs.

estimate, p_value

<data-masking> columns for the estimate and its p-value.

Value

The voe_summary tibble, invisibly. Writes three files to dir.

Examples

if (FALSE) { # \dontrun{
report_multiverse(results, dir = "outputs")
} # }