report_data_quality_table | R Documentation |
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.
report_data_quality_table(dq_table)
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. |
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.
A named list with two elements:
A character string summarizing key metrics (accuracy, RMS-S2S precision, STD precision).
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.
## Not run:
result <- report_data_quality_table(dq_table)
cat(result$txt)
head(result$measures$all)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.