REPORT

class report(**kwargs)

Class containing all the functions from the REPORT module.

Parameters

kwargsargument class

Specify any arguments from the REPORT module (for a complete list of variables, visit the ROBERT documentation)

analyze_warnings(data_score, suffix, warnings_dict, pred_type)

Analyze and append warnings

get_abbrev()

Generates the abbreviations section

get_repro(eval_only)

Generates the reproducibility section

get_transparency(spacing_PFI)

Generates the transparency section

get_warning_lines(pred_type)

Gather the lines from PREDICT where the potential warnings are print

get_warning_params()

Load spacing, colors, and line and table formats

module_lines(module, module_data, pred_type='reg', eval_only=False)

Returns the line with icon and module for section titles

print_adv_anal(pred_type, eval_only, spacing_PFI, data_score)

Generates the advanced score analysis section

print_assessment(space, suffix, data_score, style_lines, warnings_dict, color_dict, pred_type)

Add overall assessment to the ROBERT score section

print_features(warnings_dict, eval_only, spacing_PFI)

Generates the feature analysis section

print_generate(pred_type, eval_only)

Generates the GENERATE hyperoptimization section

print_header(citation_dat)

Retrieves the header for the HTML string

print_img(file_name, margin_top, height, module, pred_type, eval_only, test_set=False, diff_names=False)

Generates the string that includes couples of images to print

print_line_warning(message, style_lines, color, space)

Add line with warning

print_misc()

Generates the miscellaneous section

print_outliers(pred_type, eval_only, spacing_PFI)

Generates the outliers section

print_predictions(pred_type, eval_only, spacing_PFI)

Generates the outliers section

print_score(dat_files, pred_type, eval_only, spacing_PFI)

Generates the ROBERT score section

print_warnings(pred_type, eval_only, data_score)

Generates the warning boxes in the ROBERT score section

print_y_distrib(pred_type, eval_only, spacing_PFI, warnings_dict)

Generates the y distribution section

transpa_model_misc(section, spacing_PFI)

Collects the data for model parameters and misc options in the Reproducibility section

Parameters

destinationstr, default=None,

Directory to create the output file(s).

varfilestr, default=None

Option to parse the variables using a yaml file (specify the filename, i.e. varfile=FILE.yaml).

report_moduleslist of str, default=['CURATE','GENERATE','VERIFY','PREDICT']

List of the modules to include in the report.

debug_reportbool, default=False

Debug mode using during the pytests of report.py