Reporting Tools

This submodule contains functions used in Excel reporting, particularly by the Results class (see Results).

Functions

remove_borders(table_or_breakdown, workbook)	Removes borders around a Table or Breakdown's column headers.
report_breakdown(breakdown, writer)	Writes a Pandas Breakdown to Excel using passed writer.
report_header(dataset, workbook)	Writes a DataSet's header to Excel.
report_table(table, writer)	Writes a Table to Excel.
report_value(value, workbook)	Writes a Value to Excel.
set_default_format(workbook)	Sets all cells in an active openpyxl workbook to a default format.

chromaquant.results.reporting_tools.remove_borders(table_or_breakdown: Table | Breakdown, workbook: Workbook)

Removes borders around a Table or Breakdown’s column headers.

Parameters

table_or_breakdownTable | Breakdown

Table or Breakdown instance.

workbookWorkbook

Active openpyxl workbook.

Returns

None

chromaquant.results.reporting_tools.report_breakdown(breakdown: Breakdown, writer: ExcelWriter)

Writes a Pandas Breakdown to Excel using passed writer.

Parameters

breakdownBreakdown

Pandas Breakdown to export.

writerExcelWriter

Pandas ExcelWriter used in exporting.

Returns

None

chromaquant.results.reporting_tools.report_header(dataset: DataSet, workbook: Workbook)

Writes a DataSet’s header to Excel.

Parameters

datasetDataSet

Dataset to export the header of.

workbookWorkbook

Active openpyxl workbook.

Returns

None

chromaquant.results.reporting_tools.report_table(table: Table, writer: ExcelWriter)

Writes a Table to Excel.

Parameters

table: Table

Table to export.

writerExcelWriter

Pandas ExcelWriter used in exporting.

Returns

None

chromaquant.results.reporting_tools.report_value(value: Value, workbook: Workbook)

Writes a Value to Excel.

Parameters

value: Value

Value to export.

workbookWorkbook

Active openpyxl workbook.

Returns

None

chromaquant.results.reporting_tools.set_default_format(workbook: Workbook)

Sets all cells in an active openpyxl workbook to a default format.

Parameters

workbookWorkbook

Active openpyxl workbook.

Returns

None