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(run_id: str | None, template: str, *, mock_data: bool = False, output_dir: str | pathlib.Path | None = None, report_name: str = 'orangeqs_characterization_report', clean: bool = False, **kwargs: Any) → pathlib.Path#

Run the full pipeline to generate a report.

The pipelines consists of three steps:

  1. Copy data files to the output directory (theme, default figures, etc.)

  2. Fill the Jinja2 template with data and generate a markdown file.

  3. Use pandoc to convert the markdown file to an HTML file.

Parameters#

  • run_id (str, optional): The run ID for the report. If None, the last run ID will be used.

  • mock_data (bool, optional): If True, mock data will be used instead of real data. Defaults to False.

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

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

  • 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.