Skip to contents

Creates deterministic, reviewable scientific concordance records and suites that bind canonical analyses to datasets, external-tool versions, commands, tolerances, comparison results, provenance, citations, and explicit approval. Release readiness requires a complete declared inventory and approved passing equivalence evidence.

Usage

new_scientific_concordance_record(
  dataset_id, analysis, reference_tool, reference_version, command, result,
  tolerance_profile, environment = list(),
  approval = c("proposed", "approved"), approved_by = NULL, approved_at = NULL
)

validate_scientific_concordance_record(record, require_approved = FALSE)

new_scientific_concordance_suite(
  records, require_complete = TRUE,
  required_tools = character(), required_analyses = character()
)

validate_scientific_concordance_suite(suite)

scientific_concordance_table(suite)

write_scientific_concordance_evidence(
  suite, output_dir, require_release_ready = FALSE
)

Arguments

dataset_id

Canonical dataset identifier.

analysis

Analysis identifier.

reference_tool

External implementation name.

reference_version

External implementation version.

command

Exact command or reproducible invocation.

result

A PopgenVCFExternalReferenceResult.

tolerance_profile

Named tolerance metadata.

environment

Named environment and provenance metadata.

approval

Proposed or approved scientific state.

approved_by, approved_at

Approval metadata.

record

A concordance record.

require_approved

Require explicit scientific approval.

records

A non-empty list of concordance records.

require_complete

Require the declared tool and analysis inventory.

required_tools, required_analyses

Required inventory entries.

suite

A scientific concordance suite.

output_dir

Evidence output directory.

require_release_ready

Refuse finalization unless inventory and equivalence evidence are release ready.

Value

A validated concordance record or suite, a deterministic summary table, or named evidence paths depending on the function called.