write_summary_txt: Write a Plain-Language Run Summary

In rmoriebricklayer: Reproducible Data Capsules with Provenance and Fallback

Write a Plain-Language Run Summary

Description

Writes a human-readable SUMMARY.txt into the output directory, covering run metadata, the exact absolute paths used, result counts, the files produced, and optional notes, contact, and licence lines.

Usage

write_summary_txt(
  manifest,
  output_dir,
  paths,
  what_was_done = NULL,
  contact = NULL,
  licence = NULL
)

Arguments

manifest	A manifest as returned by make_manifest(); its meta supplies project/author/run details.
output_dir	Directory to write SUMMARY.txt into and to list produced files from.
paths	A named list of absolute paths to report (e.g. capsule, input, results, analysis_script, provenance).
what_was_done	Optional character vector of bullet points describing what the run did.
contact	Optional contact string appended to the summary.
licence	Optional licence string appended to the summary.

Value

The path to the written SUMMARY.txt, returned invisibly.

Examples

man <- make_manifest(list(project = "demo", author = "A. Author"),
                     environment = FALSE)
man <- record(man, "row_count", observed = 20, expected = 20)
out <- file.path(tempdir(), "demo-run")
dir.create(out, showWarnings = FALSE)
s <- write_summary_txt(man, out, paths = list(results = out))
readLines(s)[7:8]

rmoriebricklayer documentation built on Aug. 5, 2026, 9:08 a.m.