pecos.io.write_monitoring_report module

pecos.io.write_monitoring_report.write_monitoring_report(filename, subdirectory, pm, metrics=None, config={}, logo=False)

Generate a performance monitoring report

Parameters:

filename : string

Filename with full path

subdirectory : string

Full path to directory containing results

pm : PerformanceMonitoring object

Contains data (pm.df) and test results (pm.test_results)

metrics : pd.DataFrame (optional)

config : dict (optional)

Configuration options, to be printed at the end of the report

logo : string (optional)

Graphic to be added to the report header