Deterministic scientific release bundles
Source:R/scientific_release_bundle.R
scientific-release-bundle.RdCreate, validate, render, and write an immutable root record for a complete reproducible popgenVCF scientific release.
Usage
new_scientific_release_bundle(
release_id,
package_version,
git_commit,
git_tag,
release_date,
digest_chain,
artifacts,
dependencies = data.frame(package = character(), version = character()),
canonical_certificate = NULL,
canonical_evidence = NULL,
git_branch = "",
git_remote = "",
git_dirty = FALSE,
r_version = R.version.string,
platform = R.version$platform,
architecture = R.version$arch,
operating_system = Sys.info()[["sysname"]]
)
scientific_release_bundle_table(x)
validate_scientific_release_bundle(x)
render_scientific_release_bundle(x)
write_scientific_release_bundle(x, path, overwrite = FALSE)Arguments
- release_id
Stable release identifier.
- package_version
Released package version.
- git_commit
Full Git commit identity.
- git_tag
Release tag.
- release_date
Explicit ISO 8601 release date (`YYYY-MM-DD`).
- digest_chain
Named SHA256 identities for all required scientific records.
- artifacts
Data frame containing release-relative path, size, and SHA256.
- dependencies
Data frame containing package and version columns.
- canonical_certificate
Release-ready canonical certificate. It defaults to `NULL` for public-API compatibility but construction fails closed when it is absent.
- canonical_evidence
Data frame of validation, baseline, drift, reconciliation, and gate evidence files. It defaults to `NULL` for public-API compatibility but construction fails closed when it is absent.
- git_branch
Git branch name.
- git_remote
Git remote identity.
- git_dirty
Whether the source tree was dirty.
- r_version
R version string.
- platform
Platform string.
- architecture
Architecture string.
- operating_system
Operating-system string.
- x
A scientific release object or written bundle directory.
- path
Output directory.
- overwrite
Whether an existing directory may be replaced.