compare_matrices_and_output#

caf.toolkit.pandas_utils.matrices.compare_matrices_and_output(excel_writer, matrix_report_a, matrix_report_b, *, name_a='a', name_b='b', label=None)[source]#

Compare two matrix reports.

Parameters:

  • excel_writer (pd.ExcelWriter) – Excel writer to use to output the comparisons.

  • matrix_report_a (MatrixReport) – Matrix for comparison, this matrix will be the numerator in proportional comparisons.

  • matrix_report_b (MatrixReport) – Other matrix for comparison, this matrix will be the denominator in proportional comparisons.

  • name_a (str, optional) – name to label matrix_report_a, by default “a”

  • name_b (str, optional) – name to label matrix_report_b, by default “b”

  • label (Optional[str]) – Label to add to the sheet names

Return type:

None