Skip to contents

One-line human-readable provenance string

Source: R/utils-reproducibility.R
provenance_string.Rd

Format the key reproducibility fields of a multisiteDGP object as a single pipe-delimited string suitable for reports, preregistration appendices, paper appendices, and reviewer-facing figure captions. Includes package version, paradigm, seed, canonical hash, design hash, R version, and any custom-callback hooks.

Usage

provenance_string(x, ...)

Arguments

x

A multisitedgp_data, multisitedgp_design, or hashable object.

...

Passed to methods.

Value

A single character string.

Details

Output format:

multisiteDGP 0.1.0 | paradigm=site_size | seed=1 | canonical_hash=... | design_hash=... | hash_algo=xxhash64 | R=4.5 | hooks=none

Drop the result into a paper appendix or a vignette caption to make your simulation cite-able and reproducible. For an end-to-end reproducibility workflow see the Reproducibility and provenance vignette.

References

Lee, J., Che, J., Rabe-Hesketh, S., Feller, A., & Miratrix, L. (2025). Improving the estimation of site-specific effects and their distribution in multisite trials. Journal of Educational and Behavioral Statistics, 50(5), 731–764. doi:10.3102/10769986241254286 .

See also

canonical_hash for the underlying content hash; the M7 Reproducibility and provenance vignette.

Other family-reproducibility: canonical_hash()

Examples

dat <- sim_multisite(J = 10L, seed = 1L)
provenance_string(dat)
#> [1] "multisiteDGP 0.1.1 | paradigm=site_size | seed=1 | canonical_hash=f367529f6b9347bf | design_hash=e40e0611ff72f542 | hash_algo=xxhash64 | R=4.6.0 | hooks=none"