xcp_d.interfaces.report_core module

Tools for generating Reports.

This is from niworkflows, a patch will be submitted.

class xcp_d.interfaces.report_core.Report(out_dir, run_uuid, config=None, out_filename='report.html', packagename=None, reportlets_dir=None, subject_id=None)

Bases: Report

A modified form of niworkflows’ core Report object.

xcp_d.interfaces.report_core.generate_reports(subject_list, fmri_dir, work_dir, output_dir, run_uuid, config=None, packagename=None)

Execute run_reports on a list of subjects.

subject_listlist of str

List of subject IDs.

fmri_dirstr

The path to the fMRI directory.

work_dirstr

The path to the working directory.

output_dirstr

The path to the output directory.

run_uuidstr

The UUID of the run for which the report will be generated.

configNone or str, optional

Configuration file.

packagenameNone or str, optional

The name of the package.

xcp_d.interfaces.report_core.run_reports(out_dir, subject_label, run_uuid, config=None, reportlets_dir=None, packagename=None)

Run the reports.

Parameters:

• out_dir (str) – The output directory.

• subject_label (str) – The subject ID.

• run_uuid (str) – The UUID of the run for which the report will be generated.

• config (None or str, optional) – Configuration file.

• reportlets_dir (None or str, optional) – Path to the reportlets directory.

• packagename (None or str, optional) – The name of the package.

Returns:

An HTML file generated from a Report object.

Return type:

str