create_summary_table#

API documentation for tradeexecutor.utils.summarydataframe.create_summary_table Python function.

create_summary_table(data, column_names=None, index_name=None)[source]#

Create a summary table from a human readable data.

  • Keys are human readable labels

  • Values are instances of Value

TODO: If column_names is not provided, we get column header “zero” that needs to be hidden.

Parameters:
  • data (dict) – Human readable data in the form of a dict

  • column_names (list[str] | str | None) – Column names for the dataframe. If None, no column names are used.

  • index_name (str | None) – Name of the index column. If None, no index name is used.

Returns:

A styled pandas dataframe

Return type:

DataFrame