ffrprep.reports.build_subject_report

ffrprep.reports.build_subject_report(bids_root, subject, out_dir, sections=None, title=None, overview=None, groups=None)[source]

Render a single-file HTML preprocessing report for a subject.

Parameters:

  • bids_root (str | Path) – Top-level BIDS dataset directory. Recorded for provenance and used to resolve relative paths displayed in the report body.

  • subject (str) – BIDS subject identifier without the sub- prefix (e.g. "01").

  • out_dir (str | Path) – Directory where the rendered .html file is written. Created if missing.

  • sections (list of dict, optional) – Flat list of section descriptors. Use this when there is no natural session/task/run grouping. Mutually exclusive with groups; if both are passed, groups wins.

  • groups (list of dict, optional) – Nested structure. Each group dict carries id, title, session, task, run, and sections (list of section dicts). Construct via make_group() for the BIDS defaults. The TOC renders one foldable container per group.

  • overview (dict, optional) – Top-of-report summary card. Recognised keys: summary (key→value table) and command (rendered as a code block).

  • title (str | None) – Page title and <h1> text. Defaults to "ffrprep preprocessing report sub-{subject}".

Returns:

Absolute path to the written HTML file.

Return type:

str