Claim check crate

Version 0.1-experimental. Permalink: https://reproducible.science/ro-crate/claim-check/0.1/

Experimental. This is the export format of one tool, repro, written by repro export ro-crate. It is not a standard, it is registered with no one, and any term here may change before 1.0.

What it is for

An RO-Crate 1.3 describes files, and the Process Run Crate 0.6 profile describes the runs of the software that made them. Neither has a term for a check of this kind: the value at an address inside a file was compared with the value a manuscript prints, and here is what was found. This profile adds the terms for that and no others. A crate that conforms to it holds one entity per checked assertion, and each entity states an observation. It states no verdict on whether a claim is true.

The profile is a projection of the check record, reproducible.science/claim-check/0.1-experimental, which section 7.10 of the specification defines and whose JSON Schema is published beside this page. Records written by 0.5.6 carry the same format under the name repro.check/0.1-experimental. Every field of a record has a place in the crate, and the tool reads its own crates back into the records they were written from.

Requirements

The key words MUST, SHOULD and MAY are to be read as in RFC 2119.

• The crate MUST conform to RO-Crate 1.3, and its root data entity MUST list https://reproducible.science/ro-crate/claim-check/0.1/ under conformsTo, with a contextual entity for it whose @type includes Profile.
• The @context MUST map each term below to its permalink.
• Each checked assertion MUST be one entity typed CheckAction and ClaimCheck, with checkType, outcome, nativeOutcome, nativeReason, an instrument naming the checker as a SoftwareApplication with its version, an endTime for when the check ran, and an object naming a schema.org Claim.
• Each file a check read MUST be a FileRead with readsFile, and SHOULD carry canonicalAddress and, where a value was read, value.
• A File SHOULD carry sha256 for the bytes on disk, pinnedDigest for the digest the manifest pins, and validity. A file that is absent, or outside the project, MUST use an identifier beginning with #, as RO-Crate provides for a file that is not in the crate.
• An outcome of match or mismatch MUST mean that the file was read, the address resolved and a comparison ran. A consumer that does not know a nativeOutcome, a checkType or an addressKind MUST NOT read the check as a match.
• No property is a boolean. Whether a file is the pinned one is validity, and is never folded into an outcome.
• A command the manifest declares is a DeclaredCommand, and a recorded re-run of it is a CreateAction as Process Run Crate describes one, with the command as its instrument. A check refers to the commands upstream of what it reads with upstream and does not restate them. A crate declares conformance to Process Run Crate only where it holds a re-run.

Terms taken from RO-Crate and schema.org

An example

{
  "@id": "#check/responders/0",
  "@type": ["CheckAction", "ClaimCheck"],
  "name": "responders metric responders",
  "instrument": {"@id": "#checker/repro/0.5.5"},
  "object": {"@id": "#claim/responders"},
  "endTime": "2026-10-13T12:00:00+00:00",
  "checkType": {"@id": "https://reproducible.science/ro-crate/claim-check/0.1/#value-comparison"},
  "fileRead": {"@id": "#check/responders/0/read/0"},
  "printedValue": "35",
  "comparisonMode": "printed_precision",
  "tolerance": "0",
  "outcome": {"@id": "https://reproducible.science/ro-crate/claim-check/0.1/#mismatch"},
  "nativeOutcome": "mismatch",
  "nativeReason": "value_mismatch"
},
{
  "@id": "#check/responders/0/read/0",
  "@type": ["PropertyValue", "FileRead"],
  "readsFile": {"@id": "totals.json"},
  "addressKind": "tree",
  "canonicalAddress": "{\"contract\":1,\"kind\":\"tree\",\"pointer\":\"/responders\"}",
  "value": "36"
}

Classes

Properties

On a ClaimCheck

On a Claim

On a FileRead

On a File

On a DeclaredCommand

On the CreateAction of a re-run

Outcomes

The values of outcome, each defined by what has to have happened.

Check types

The values of checkType. The tool writes the first four.