MatrixReport.write_to_excel#

MatrixReport.write_to_excel(writer, label=None, output_matrix=False)[source]#

Write matrix report to multiple sheets in an Excel file.

Writes 2 (or 3) sheets to the file with names “label`_Summary”, “`label`_Trip_Ends” and “`label`_Matrix” (if `output_matrix is True).

Parameters:

  • writer (pd.ExcelWriter) – Excel file to write reports to.

  • label (str, optional) – Prefix for sheet names, will have “_” and the report name appended.

  • output_matrix (bool, default False) – If True outputs the matrix to an Excel sheet, False is recommended for larger matrices as writing large data to Excel may be slow.

Return type:

None