Canonical validation suites — canonical_validation

Construct, execute, summarize, and write deterministic evidence for multi-dataset canonical validation suites.

Usage

new_canonical_validation_suite(id, title, fail_fast = TRUE, metadata = list())

register_canonical_validation(suite, id, directory, validation = NULL,
  replace = FALSE)

validate_canonical_validation_suite(suite)

run_canonical_validation_suite(suite, registry)

canonical_validation_suite_table(result)

canonical_validation_coverage(suite, registry)

write_canonical_validation_suite(result, output_dir)

Arguments

id: Stable suite or dataset identifier.
title: Human-readable suite title.
fail_fast: Whether execution stops after the first failure or error.
metadata: Optional named metadata list.
suite: A canonical validation suite.
directory: Materialized canonical dataset directory.
validation: Optional dataset-specific validation function returning a data frame with a logical passed column.
replace: Whether an existing suite entry may be replaced.
registry: An approved canonical dataset registry.
result: A canonical validation suite result.
output_dir: Evidence output directory.

Value

Constructors and registration functions return validated suite objects. Execution returns a PopgenVCFCanonicalValidationSuiteResult. Summary functions return deterministic data frames. The evidence writer returns normalized output paths.