xcp_d.interfaces.report_core.run_reports

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

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