orangeqs.juice.reporting.make#

Utilities to run the full report generation pipeline.

Package Contents#

Functions#

make_report

Run the full pipeline to generate a report.

API#

orangeqs.juice.reporting.make.make_report(*, output_dir: str | pathlib.Path | None = '/home/user/reports', clean: bool = False, **kwargs: Any) → pathlib.Path#

Run the full pipeline to generate a report.

Parameters#

  • template (str, optional): The name of the Jinja2 template to use for report generation. Defaults to “master_template_oqs_theme.md.jinja”. The template should be located in the templating engine’s template directory or be accessible via the templating engine’s template loading mechanism.

  • output_dir (str, optional): The directory where the report will be saved. If None, a temporary directory will be created.

  • report_name (str, optional): The name of the report file. Defaults to “orangeqs_characterization_report”.

  • clean (bool, optional): If True, all files in the output directory will be permanently removed before generating the report. Defaults to False.

  • **kwargs: Any: Additional keyword arguments to be passed to the templating engine. This can include any parameters required for data fetching, processing, or template rendering.

Returns#

  • (: Path): The path to the generated HTML report. All files in the parent directory of the HTML file are required to view the report correctly.