Skip to contents

Construct versioned baseline snapshots, assess pairwise and historical scientific drift, summarize classifications, and write deterministic evidence.

Usage

new_canonical_drift_profile(minor = 1, moderate = 2, major = 5)

new_canonical_baseline_snapshot(id, registry, recorded_at,
  provenance = list())

assess_canonical_baseline_drift(previous, current,
  profile = new_canonical_drift_profile())

canonical_drift_table(assessment)

canonical_drift_history(snapshots,
  profile = new_canonical_drift_profile())

canonical_drift_summary(assessment)

write_canonical_drift_evidence(assessment, output_dir)

Arguments

minor

Maximum normalized drift classified as minor.

moderate

Maximum normalized drift classified as moderate.

major

Maximum normalized drift classified as major.

id

Stable snapshot identifier.

registry

A canonical baseline registry.

recorded_at

ISO-8601 date or datetime.

provenance

Optional named provenance metadata.

previous

Earlier canonical baseline snapshot.

current

Later canonical baseline snapshot.

profile

Canonical drift threshold profile.

assessment

A canonical drift assessment or history.

snapshots

Explicitly ordered list of at least two baseline snapshots.

output_dir

Evidence output directory.

Value

Constructors return validated profile and snapshot objects. Pairwise assessment returns a PopgenVCFCanonicalDriftAssessment; historical assessment returns a PopgenVCFCanonicalDriftHistory. Table and summary functions return deterministic data frames. The evidence writer returns normalized output paths.

Details

Numeric drift is normalized against the larger approved tolerance from the previous and current baseline versions. Default classifications are stable, minor, moderate, major, and breaking. Incompatible contracts and missing historical metrics are classified as breaking.