% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/hrv-features.R
\name{summarise_gazepoint_hrv_features}
\alias{summarise_gazepoint_hrv_features}
\title{Summarise time-domain HRV features from Gazepoint IBI/RR intervals}
\usage{
summarise_gazepoint_hrv_features(
  data,
  ibi_col = NULL,
  group_cols = NULL,
  time_col = NULL,
  ibi_unit = c("auto", "seconds", "milliseconds"),
  min_ibi_ms = 300,
  max_ibi_ms = 2000,
  min_valid_ibi = 3L
)
}
\arguments{
\item{data}{A data frame.}

\item{ibi_col}{Optional IBI/RR interval column. If \code{NULL}, a likely IBI/RR
column is detected. The raw \code{HRV} column is never selected automatically.}

\item{group_cols}{Optional grouping columns, such as participant, stimulus,
trial, or window.}

\item{time_col}{Optional time/order column used to order IBI values within
each group before calculating successive-difference features.}

\item{ibi_unit}{Unit of the IBI/RR column. Use \code{"auto"}, \code{"seconds"}, or
\code{"milliseconds"}.}

\item{min_ibi_ms}{Minimum plausible IBI in milliseconds.}

\item{max_ibi_ms}{Maximum plausible IBI in milliseconds.}

\item{min_valid_ibi}{Minimum number of valid IBI values required before a
group is marked as having computed HRV features.}
}
\value{
A list with \code{overview}, \code{features}, and \code{settings}.
}
\description{
Computes conservative time-domain HRV-style features from genuine interbeat
interval or RR interval columns. The raw Gazepoint \code{HRV} column is not used
as an HRV metric because it is treated as a validity/vendor flag unless
independently documented otherwise.
}
\details{
The helper computes descriptive features including mean IBI, mean heart rate
derived from IBI, SDNN, RMSSD, and pNN50. It does not compute frequency-domain
HRV and does not replace specialised ECG/PPG HRV software.
}
\examples{
df <- data.frame(
  participant = "P1",
  IBI = c(0.9, 1.0, 1.1, 1.0, 0.95)
)
summarise_gazepoint_hrv_features(df, group_cols = "participant")

}
