ffrprep.reports.build_metrics_table_section¶

ffrprep.reports.build_metrics_table_section(metrics, *, section_id, title, max_table_rows=40, extra_summary=None)[source]¶

Build a section descriptor summarizing a group-level metrics table.

metrics is a per-(task, run) DataFrame such as ffrprep.group.compute_subject_metrics() returns: one row per subject, columns are scalar FFR metrics recomputed from saved participant-level derivatives. The summary table reports the group mean +/- SD for each metric. Up to max_table_rows subjects the full per-subject table is rendered as a figure; for larger cohorts (where a table would be unreadably tall) the figure shows one histogram per metric instead and the per-subject values live in the accompanying _metrics.tsv. extra_summary (a dict of label to text) adds entries to the summary table, e.g. the QC-flag count.