% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/workflow.R
\name{run_gazepoint_biometrics_workflow}
\alias{run_gazepoint_biometrics_workflow}
\title{Run a Gazepoint Biometrics workflow}
\usage{
run_gazepoint_biometrics_workflow(
  path,
  group_columns = NULL,
  recursive = FALSE,
  include_fixations = FALSE,
  include_all_gaze = TRUE,
  include_other_csv = FALSE,
  require_active_signal = TRUE,
  create_exclusion_recommendations = TRUE,
  gsr_min_usable_pct = 50,
  hr_min_usable_pct = 50,
  dial_min_usable_pct = 50,
  extract_ttl_events = TRUE,
  ttl_event_mode = c("changes", "nonzero"),
  audit_sampling = TRUE,
  sampling_group_columns = NULL,
  sampling_time_column = NULL,
  sampling_time_unit = c("samples", "seconds", "milliseconds", "microseconds"),
  expected_sampling_rate_hz = 60
)
}
\arguments{
\item{path}{Folder containing Gazepoint CSV exports.}

\item{group_columns}{Optional columns used to create multimodal window
summaries, such as \code{c("source_participant", "MEDIA_ID")}.}

\item{recursive}{Should subfolders be searched?}

\item{include_fixations}{Should fixation files be imported? Defaults to
\code{FALSE} because continuous biometric summaries should usually be computed
from all-gaze sample-level exports rather than fixation-level exports.}

\item{include_all_gaze}{Should all-gaze files be imported?}

\item{include_other_csv}{Should other non-Data-Summary CSV files be attempted?}

\item{require_active_signal}{Logical. Should inactive biometric signals be
flagged in validation/checklist outputs?}

\item{create_exclusion_recommendations}{Logical. Should window-level and
participant-level keep/review/exclude recommendations be created when
\code{group_columns} are supplied?}

\item{gsr_min_usable_pct}{Minimum acceptable usable percentage for GSR/EDA
windows.}

\item{hr_min_usable_pct}{Minimum acceptable usable percentage for heart-rate
windows.}

\item{dial_min_usable_pct}{Minimum acceptable usable percentage for
engagement-dial windows.}

\item{extract_ttl_events}{Logical. Should TTL marker events be extracted?}

\item{ttl_event_mode}{TTL event extraction mode passed to
\code{extract_gazepoint_ttl_events()}. Use \code{"changes"} or \code{"nonzero"}.}

\item{audit_sampling}{Logical. Should sampling/timing information be audited?}

\item{sampling_group_columns}{Optional columns for the sampling audit. If
\code{NULL}, the workflow uses available file/participant/media columns.}

\item{sampling_time_column}{Optional time/order column for the sampling audit.}

\item{sampling_time_unit}{Unit of the selected time/order column. Use
\code{"seconds"}, \code{"milliseconds"}, \code{"microseconds"}, or \code{"samples"}.}

\item{expected_sampling_rate_hz}{Optional expected sampling rate in Hz.}
}
\value{
A list with imported data, validation outputs, missingness summaries,
quality audits, sampling/timing audits, optional window summaries, optional
exclusion recommendations, optional TTL events, checklist, and methods
text. The object has class \code{"gazepoint_biometrics_workflow"}.
}
\description{
Runs a compact end-to-end workflow for Gazepoint Biometrics exports. The
workflow imports rectangular all-gaze/fixation-style CSV exports from a
folder, validates biometric columns, detects active channels, audits
missingness, signal quality, sampling/timing, optionally creates window-level
summaries, creates optional biometric exclusion recommendations, extracts
optional TTL marker events, and produces checklist and methods-text outputs.
}
