xcp_d.interfaces.execsummary module

Classes for building an executive summary file.

class xcp_d.interfaces.execsummary.ExecutiveSummary(xcpd_path, subject_id, session_id=None)[source]

Bases: object

A class to build an executive summary.

Parameters:

xcpd_path (str) – Path to the xcp-d derivatives.
subject_id (str) – Subject ID.
session_id (None or str, optional) – Session ID.

collect_inputs()[source]: Collect inputs.

generate_report(out_file=None)[source]: Generate the report.

write_html(document, filename)[source]

Write an html document to a filename.

Parameters:

document (str) – html document.
filename (str) – name of html file.