% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/schema-helpers.R
\name{standardise_gazepoint_biometric_names}
\alias{standardise_gazepoint_biometric_names}
\title{Standardise Gazepoint biometric column names}
\usage{
standardise_gazepoint_biometric_names(
  data,
  style = c("canonical", "snake"),
  rename = TRUE
)
}
\arguments{
\item{data}{A data frame or a character vector of column names.}

\item{style}{Naming style to return. \code{"canonical"} returns uppercase
Gazepoint-style names for recognised columns. \code{"snake"} returns lowercase
snake-case names.}

\item{rename}{Logical. If \code{data} is a data frame, should the returned data
frame have standardised names? If \code{FALSE}, a name-mapping table is returned.}
}
\value{
If \code{data} is a character vector, a character vector of standardised
names. If \code{data} is a data frame and \code{rename = TRUE}, the data frame with
standardised names. If \code{rename = FALSE}, a data frame mapping original names
to standardised names.
}
\description{
Standardises common Gazepoint Biometrics column-name variants to stable
canonical names. The helper is intentionally conservative: it recognises
common biometric, timing, marker, participant, and stimulus columns, but it
leaves unknown columns unchanged apart from optional snake-case cleaning.
}
\examples{
standardise_gazepoint_biometric_names(c("time ms", "heart rate", "eda uS"))

df <- data.frame(`time ms` = 1:3, `heart rate` = c(70, 72, 71))
names(standardise_gazepoint_biometric_names(df))

}
