generate_report¶

Attributes¶

`ENCODING`
`CONTEXT_FOLDER`
`TOP_N`
`TOP_K`
`VERBOSE_DEFAULT`
`DATA_FOLDER`
`ALL_CONTEXT_FILENAME`
`PARAMS_FILENAME`
`TEMPLATES_FOLDER`
`INTRODUCTION_FILENAME`
`OVERVIEW_FILENAME`
`ALL_CONTEXT_HEADER_TEMPLATE`
`ALL_CONTEXT_CONTENT_TEMPLATE`
`SINGLE_CONTEXT_TEMPLATE`
`generator`

Classes¶

ReportGenerator

Module Contents¶

ENCODING = 'utf-8'¶

CONTEXT_FOLDER = 'by-context'¶

TOP_N = 10¶

TOP_K = 10¶

VERBOSE_DEFAULT = False¶

DATA_FOLDER = 'aggregated_data'¶

ALL_CONTEXT_FILENAME = 'all_contexts.qmd'¶

PARAMS_FILENAME = 'params.yml'¶

TEMPLATES_FOLDER = './assets/templates'¶

INTRODUCTION_FILENAME = 'getting-started.qmd'¶

OVERVIEW_FILENAME = 'overview.qmd'¶

ALL_CONTEXT_HEADER_TEMPLATE = 'all_context_header.qmd'¶

ALL_CONTEXT_CONTENT_TEMPLATE = 'all_context_content.qmd'¶

SINGLE_CONTEXT_TEMPLATE = 'context.qmd'¶

class ReportGenerator¶

report_folder¶

root_dir = ''¶

data_folder = ''¶

top_n = None¶

top_k = None¶

by_context_folder = 'Uninferable/by-context'¶

all_context_filepath = 'Uninferable/by-context/all_contexts.qmd'¶

_log_params()¶

_read_params()¶

static _get_context_string(context_info) → str¶

Return type:: str

static _read_template(template_filename: str) → str¶

Read a template file and return its content.

Parameters:: template_filename (str)
Return type:: str

_write_single_context_file(filename: str, template: str, context_string: str, context_label: str)¶

Parameters:

filename (str)
template (str)
context_string (str)
context_label (str)

_write_header_to_file()¶

_append_content_to_file(template: str, context_string: str, context_label: str, context: dict)¶

Parameters:

template (str)
context_string (str)
context_label (str)
context (dict)

_get_unique_contexts()¶

_generate_by_context_qmds()¶

_generate_overview_qmd()¶

_generate_introduction_qmd()¶

run()¶: Main method to generate the report files.

generator¶