Warning

This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

Source code for galaxy.workflow.reports

from galaxy.exceptions import RequestParameterInvalidException
from galaxy.util import plugin_config

DEFAULT_REPORT_GENERATOR_TYPE = "markdown"



[docs]def generate_report(trans, invocation, runtime_report_config_json=None, plugin_type=None, target_format="json"):
    import galaxy.workflow.reports.generators

    plugin_classes = plugin_config.plugins_dict(galaxy.workflow.reports.generators, "plugin_type")
    plugin_type = plugin_type or DEFAULT_REPORT_GENERATOR_TYPE
    plugin = plugin_classes[plugin_type]()
    if target_format == "json":
        return plugin.generate_report_json(trans, invocation, runtime_report_config_json=runtime_report_config_json)
    elif target_format == "pdf":
        return plugin.generate_report_pdf(trans, invocation, runtime_report_config_json=runtime_report_config_json)
    else:
        raise RequestParameterInvalidException(f"Unknown report format [{target_format}]")