format_multipair_summary

API documentation for tradeexecutor.analysis.multipair.format_multipair_summary Python function.

format_multipair_summary(df, sort_column='Total return %', ascending=False, format_columns=True, limit=None)

Format the multipair summary table.

Convert raw numbers to preferred human format.

Parameters:

• df (DataFrame) –

  Input table.

  See analyse_pair_trades().

• format_columns – If True, format columns with clickable links. Provided as option since some users may want to export the tables without html markup.

Returns:

Dataframe with formatted values for each trading pair.

If there are no trades return empty dataframe.

Return type:

DataFrame