DCC (version 1.2.1)

dcc_findings: The dcc_findings table

Description

A dcc_findings object is the structured violation list produced by the Detect stage and consumed by the Execute stage: columns finding_id, record_id, variable, check_id, evidence, severity, dimension, code and detector_id. The additive finding_id is deterministic within a run and includes the rule, record, variable, and zero-based occurrence. It is the single interface between detection and execution in the Detect-Execute-Report workflow.

Usage

dcc_findings(record_id = character(), variable = NA_character_,
  check_id = character(), evidence = character(), severity = "warn",
  dimension = NA_character_, run_id = "manual", code = check_id,
  detector_id = check_id)

Value

A dcc_findings object (also a data.table).

Arguments

record_id

Character vector (or coercible) of record ids.

variable

Character vector of affected variables, or NA.

check_id

Character vector of check identifiers.

evidence

Character vector describing the measured evidence.

severity

One of "info", "warn", "fail" (recycled).

dimension

Quality dimension label (recycled).

run_id

One non-empty run identifier used to make finding IDs stable.

code

Stable machine-readable finding code (recycled). Defaults to check_id for backward compatibility.

detector_id

Stable detector implementation identifier (recycled). Defaults to check_id for direct legacy detector calls.

Examples

dcc_findings(record_id = "S001", check_id = "R001",
             evidence = "value 7 outside range [1, 5]",
             severity = "fail", dimension = "validity")