compare_matrices#

caf.toolkit.pandas_utils.matrices.compare_matrices(matrix_report_a, matrix_report_b, name_a='a', name_b='b')[source]#

Compare two matrix reports.

Parameters:

  • 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”

Returns:

Dictionary containing comparison statistics.

Return type:

dict[str, pd.DataFrame]

Raises:

ValueError – if either matrix report does not have a sector matrix.