% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/biometrics-report.R
\name{create_gazepoint_biometrics_report}
\alias{create_gazepoint_biometrics_report}
\title{Create a Gazepoint Biometrics report}
\usage{
create_gazepoint_biometrics_report(
  data = NULL,
  workflow = NULL,
  validation = NULL,
  quality = NULL,
  sampling = NULL,
  missingness = NULL,
  exclusions = NULL,
  report_tables = NULL,
  methods_text = NULL,
  checklist = NULL,
  title = "Gazepoint Biometrics report",
  subtitle = NULL,
  output_file = NULL,
  format = c("markdown", "html"),
  include_timestamp = FALSE,
  overwrite = FALSE,
  max_table_rows = 20L
)
}
\arguments{
\item{data}{Optional biometric data frame.}

\item{workflow}{Optional workflow object or workflow summary list.}

\item{validation}{Optional validation object or data frame.}

\item{quality}{Optional quality-audit object or data frame.}

\item{sampling}{Optional sampling-audit object or data frame.}

\item{missingness}{Optional missingness-audit object or data frame.}

\item{exclusions}{Optional exclusion-recommendation object or data frame.}

\item{report_tables}{Optional report-table object, data frame, or named list
of data frames.}

\item{methods_text}{Optional methods text, character vector, or object
returned by \code{create_gazepoint_biometrics_methods_text()}.}

\item{checklist}{Optional checklist object or data frame.}

\item{title}{Report title.}

\item{subtitle}{Optional report subtitle.}

\item{output_file}{Optional path to write a report file.}

\item{format}{Output format when \code{output_file} is supplied. Supported values
are \code{"markdown"} and \code{"html"}.}

\item{include_timestamp}{Logical. Should a creation timestamp be included?}

\item{overwrite}{Logical. Should an existing \code{output_file} be overwritten?}

\item{max_table_rows}{Maximum number of rows shown per table in the written
report.}
}
\value{
A list of class \code{"gazepoint_biometrics_report"} with \code{overview},
\code{sections}, \code{tables}, \code{objects}, \code{output_file}, and \code{settings}.
}
\description{
Creates a structured, manuscript-oriented report object for Gazepoint
Biometrics data, workflow outputs, quality checks, report tables, methods
text, and reporting checklists. The report is intentionally conservative:
GSR/EDA is described as electrodermal activity/arousal-related signal rather
than emotional valence; heart-rate interpretation is tied to baseline/task
context; eye-tracking is described as visual attention rather than direct
cognition; and raw \code{HRV} columns are not treated as HRV metrics.
}
\details{
The function can also write a lightweight Markdown or HTML file without
adding heavy reporting dependencies.
}
\examples{
df <- data.frame(
  CNT = 1:5,
  GSR = c(1, 1.1, 1.2, 1.1, 1),
  HR = c(70, 71, 72, 71, 70),
  DIAL = c(40, 42, 44, 43, 41)
)
report <- create_gazepoint_biometrics_report(df)
names(report)

}
