src.report.meta_report

Classes

MetaReport(reports, **kwargs)

class src.report.meta_report.MetaReport(reports, **kwargs)
Author:

Alberto M. Esmoris Pena

Class for handling many reports at the same time.

Variables:

reports (dict) – The many reports in a dictionary. For each report there must be an entry specifying “name” as string, “report” as a Report derived object, and “path_key” as the key of the argument used to write the report to a file.

__init__(reports, **kwargs)

Root initialization for any instance of type Report.

Parameters:

kwargs – The attributes for the report.

to_file(path, out_prefix=None, **kwargs)

Write the many reports to their corresponding files.

Parameters:

  • path – The default path, i.e., the one associated with the “path” key.

  • out_prefix – The output prefix to expand the path (OPTIONAL).

  • kwargs – The key-word arguments. They must contain all relevant path specifications to handle each report.

Returns:

Nothing, the output is written to the corresponding files.