pdstools.utils.report_utils

Attributes

logger

Functions

get_output_filename(→ str)

Generate the output filename based on the report parameters.

copy_quarto_file(→ None)

Copy the report quarto file to the temporary directory.

_write_params_files(→ None)

Write parameters to a YAML file.

run_quarto(, verbose)

Run the Quarto command to generate the report.

_set_command_options(→ List[str])

Set the options for the Quarto command.

copy_report_resources(resource_dict)

generate_zipped_report(output_filename, folder_to_zip)

_get_cmd_output(→ List[str])

Get command output in an OS-agnostic way.

_get_version_only(→ str)

Extract version number from version string.

get_quarto_with_version(→ Tuple[pathlib.Path, str])

Get Quarto executable path and version.

get_pandoc_with_version(→ Tuple[pathlib.Path, str])

Get Pandoc executable path and version.

quarto_print(text)

quarto_callout_info(info)

quarto_callout_important(info)

quarto_plot_exception(plot_name, e)

quarto_callout_no_prediction_data_warning([extra])

quarto_callout_no_predictor_data_warning([extra])

polars_col_exists(df, col)

polars_subset_to_existing_cols(all_columns, cols)

rag_background_styler([rag])

rag_background_styler_dense([rag])

rag_textcolor_styler([rag])

table_standard_formatting(source_table[, title, ...])

table_style_predictor_count(gt, flds[, ...])

n_unique_values(dm, all_dm_cols, fld)

max_by_hierarchy(dm, all_dm_cols, fld, grouping)

avg_by_hierarchy(dm, all_dm_cols, fld, grouping)

sample_values(dm, all_dm_cols, fld[, n])

show_credits(quarto_source)

_serialize_query(→ Optional[Dict])

Module Contents

logger
get_output_filename(name: str | None, report_type: str, model_id: str | None = None, output_type: str = 'html') → str

Generate the output filename based on the report parameters.

Parameters:

  • name (Optional[str])

  • report_type (str)

  • model_id (Optional[str])

  • output_type (str)

Return type:

str

copy_quarto_file(qmd_file: str, temp_dir: pathlib.Path) → None

Copy the report quarto file to the temporary directory.

Parameters:
Return type:

None

_write_params_files(temp_dir: pathlib.Path, params: Dict | None = None, project: Dict = {'type': 'default'}, analysis: Dict | None = None) → None

Write parameters to a YAML file.

Parameters:

  • temp_dir (pathlib.Path)

  • params (Optional[Dict])

  • project (Dict)

  • analysis (Optional[Dict])

Return type:

None

run_quarto(qmd_file: str | None = None, output_filename: str | None = None, output_type: str | None = 'html', params: Dict | None = None, project: Dict = {'type': 'default'}, analysis: Dict | None = None, temp_dir: pathlib.Path = Path('.'), verbose: bool = False) → int

Run the Quarto command to generate the report.

Parameters:

  • qmd_file (Optional[str])

  • output_filename (Optional[str])

  • output_type (Optional[str])

  • params (Optional[Dict])

  • project (Dict)

  • analysis (Optional[Dict])

  • temp_dir (pathlib.Path)

  • verbose (bool)

Return type:

int

_set_command_options(output_type: str | None = None, output_filename: str | None = None, execute_params: bool = False) → List[str]

Set the options for the Quarto command.

Parameters:

  • output_type (Optional[str])

  • output_filename (Optional[str])

  • execute_params (bool)

Return type:

List[str]

copy_report_resources(resource_dict: list[tuple[str, str]])
Parameters:

resource_dict (list[tuple[str, str]])

generate_zipped_report(output_filename: str, folder_to_zip: str)
Parameters:

  • output_filename (str)

  • folder_to_zip (str)

_get_cmd_output(args: List[str]) → List[str]

Get command output in an OS-agnostic way.

Parameters:

args (List[str])

Return type:

List[str]

_get_version_only(versionstr: str) → str

Extract version number from version string.

Parameters:

versionstr (str)

Return type:

str

get_quarto_with_version(verbose: bool = True) → Tuple[pathlib.Path, str]

Get Quarto executable path and version.

Parameters:

verbose (bool)

Return type:

Tuple[pathlib.Path, str]

get_pandoc_with_version(verbose: bool = True) → Tuple[pathlib.Path, str]

Get Pandoc executable path and version.

Parameters:

verbose (bool)

Return type:

Tuple[pathlib.Path, str]

quarto_print(text)
quarto_callout_info(info)
quarto_callout_important(info)
quarto_plot_exception(plot_name: str, e: Exception)
Parameters:
quarto_callout_no_prediction_data_warning(extra='')
quarto_callout_no_predictor_data_warning(extra='')
polars_col_exists(df, col)
polars_subset_to_existing_cols(all_columns, cols)
rag_background_styler(rag: str | None = None)
Parameters:

rag (Optional[str])

rag_background_styler_dense(rag: str | None = None)
Parameters:

rag (Optional[str])

rag_textcolor_styler(rag: str | None = None)
Parameters:

rag (Optional[str])

table_standard_formatting(source_table, title=None, subtitle=None, rowname_col=None, groupname_col=None, cdh_guidelines=CDHGuidelines(), highlight_limits: Dict[str, str | List[str]] = {}, highlight_lists: Dict[str, List[str]] = {}, highlight_configurations: List[str] = [], rag_styler: callable = rag_background_styler)
Parameters:

  • highlight_limits (Dict[str, Union[str, List[str]]])

  • highlight_lists (Dict[str, List[str]])

  • highlight_configurations (List[str])

  • rag_styler (callable)

table_style_predictor_count(gt, flds, cdh_guidelines=CDHGuidelines(), rag_styler=rag_textcolor_styler)
n_unique_values(dm, all_dm_cols, fld)
max_by_hierarchy(dm, all_dm_cols, fld, grouping)
avg_by_hierarchy(dm, all_dm_cols, fld, grouping)
sample_values(dm, all_dm_cols, fld, n=6)
show_credits(quarto_source: str)
Parameters:

quarto_source (str)

_serialize_query(query: pdstools.utils.types.QUERY | None) → Dict | None
Parameters:

query (Optional[pdstools.utils.types.QUERY])

Return type:

Optional[Dict]