report_data_quality_table: Summarize and Report Data Quality Metrics

report_data_quality_tableR Documentation

Summarize and Report Data Quality Metrics

Description

This function summarizes data quality metrics from a validation procedure by computing averages per participant and generating descriptive statistics across participants. It also returns a formatted textual summary suitable for reporting.

Usage

report_data_quality_table(dq_table)

Arguments

dq_table

A 'data.frame' containing data quality metrics. Must include columns 'file', 'eye', 'target_id', and relevant numeric metrics such as 'offset', 'rms_s2s', and 'std'. This would generally be created by concatenating the output of the compute_data_quality_from_validation() for multiple files.

Details

The summary text excludes BCEA and data loss metrics. BCEA is considered a niche metric and data loss is best reported across the full dataset rather than just the validation subset.

Value

A named list with two elements:

txt

A character string summarizing key metrics (accuracy, RMS-S2S precision, STD precision).

measures

A list containing:

  • all: A data frame with per-participant averages (grouped by 'file').

  • mean, std, min, max: Named numeric vectors with summary statistics across participants.

Examples

## Not run: 
result <- report_data_quality_table(dq_table)
cat(result$txt)
head(result$measures$all)

## End(Not run)


ETDQualitizer documentation built on Sept. 9, 2025, 5:40 p.m.