% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils.R
\name{dq_result}
\alias{dq_result}
\title{Construct a data quality result object}
\usage{
dq_result(
  check_id,
  check_name,
  column = NA_character_,
  status,
  observed,
  threshold = NA_character_,
  message
)
}
\arguments{
\item{check_id}{Character. Short identifier for the check (e.g. \code{"QC-01"}).}

\item{check_name}{Character. Human-readable name of the check.}

\item{column}{Character. Column the check applies to, or \code{NA_character_}
for row-level or file-level checks.}

\item{status}{Character. One of \code{"PASS"}, \code{"WARN"}, \code{"FAIL"},
or \code{"INFO"}.}

\item{observed}{Character. What was observed (e.g. \code{"5.2\% missing"}).}

\item{threshold}{Character. The configured threshold, or \code{NA_character_}
if not applicable.}

\item{message}{Character. Human-readable description of the result.}
}
\value{
A named list with seven elements: \code{check_id}, \code{check_name},
  \code{column}, \code{status}, \code{observed}, \code{threshold},
  \code{message}.
}
\description{
Creates the atomic result unit returned by every check function.
}
\examples{
dq_result("QC-01", "Missing rate", column = "age",
          status = "PASS", observed = "0\% missing",
          message = "No missing values.")

}
