% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/validity-dropouts.R
\name{summarise_gazepoint_biometric_validity}
\alias{summarise_gazepoint_biometric_validity}
\title{Summarise validity and availability of Gazepoint biometric signals}
\usage{
summarise_gazepoint_biometric_validity(
  data,
  signal_cols = NULL,
  validity_cols = NULL,
  group_cols = NULL,
  active_min_unique = 2L
)
}
\arguments{
\item{data}{A data frame.}

\item{signal_cols}{Optional character vector of biometric signal columns to
summarise. If \code{NULL}, common Gazepoint biometric signal columns are detected
from the column names.}

\item{validity_cols}{Optional character vector of validity-flag columns to
summarise. If \code{NULL}, common validity-like columns are detected, including
\code{HRV} when present.}

\item{group_cols}{Optional character vector of grouping columns, such as
participant, stimulus, trial, or condition columns.}

\item{active_min_unique}{Minimum number of unique finite values required for
a numeric signal to be treated as active.}
}
\value{
A list with \code{overview}, \code{signals}, \code{validity_flags},
\code{group_summary}, and \code{settings}.
}
\description{
Summarises missingness, finite numeric availability, variability, and optional
validity-flag columns for Gazepoint Biometrics data. The helper is descriptive:
it reports whether biometric signals appear available and usable, but it does
not infer emotion, valence, or HRV from ambiguous raw columns. In particular,
raw \code{HRV} columns are treated as validity/vendor flags unless the user has
independent documentation proving otherwise.
}
\examples{
df <- data.frame(
  USER = rep(c("P1", "P2"), each = 4),
  GSR = c(1, 2, NA, 4, 2, 2, 2, 2),
  HR = c(70, 71, 72, NA, 80, 81, 82, 83),
  HRV = c(1, 1, 0, 1, 1, 1, 1, 1)
)
summarise_gazepoint_biometric_validity(df, group_cols = "USER")

}
