Skip to content

v0.1.0

Choose a tag to compare

View all tags
@ronfinn ronfinn released this 30 Aug 21:43
· 3 commits to main since this release
v0.1.0
06dc01c

First useful public release of sci-contract.

  • AnnData contracts — required obs/var columns, non-null and allowed-value constraints, unique observation and variable identifiers.
  • SpatialData contracts — required elements by collection and required coordinate systems, plus table-to-region links, opt-in instance-to-region integrity, and per-element coordinate-system registrations.
  • Provenance — required reproducibility fields read from uns["provenance"].
  • Reports — a structured text report and a JSON report with a stable schema_version and stable issue codes.
  • Nextflow example — examples/nextflow/ runs the validation as a pipeline quality gate: the report is published either way, and the workflow fails when the dataset does not satisfy its contract.

The contract format is specified in docs/contract-format.md and the report format in docs/report-format.md, each with its current limitations.

Assets 2
Loading