plot_roi

scikitplot.decile.plot_roi(plot_input, *, fixed_costs, variable_costs_per_unit, profit_per_unit, highlight_ntile=None, highlight_how='plot_text', autopct='%.2f%%', line_kws=None, ref_line_kws=None, legend_kws=None, grid_kws=None, axes_kws=None, annotation_kws=None, footer_kws=None, save_fig=True, save_fig_filename='', **kwargs)

Plot ROI (return on investment) curve.

Parameters:

plot_inputpandas.DataFrame

Output of ModelPlotPy.plotting_scope.

fixed_costsfloat

Fixed costs independent of selection size.

variable_costs_per_unitfloat

Variable cost per selected unit.

profit_per_unitfloat

Revenue per positive unit.

highlight_ntileint or Sequence[int] or None, default=None

Ntile index/indices to highlight (each in 1..ntiles).

highlight_how{‘plot’, ‘text’, ‘plot_text’}, default=’plot_text’

Where to render highlight information.

autopctNone or str or callable, default=’%.2f%%’

Percentage formatter for ROI (expressed as a fraction).

line_kws, ref_line_kws, legend_kws, grid_kws, axes_kws, annotation_kws, footer_kwsMapping[str, Any] or None

Per-component styling kwargs.

**kwargsAny

Legacy alias for line_kws.

Returns:

matplotlib.axes.Axes

Axes containing the plot.

Other Parameters:

show_figbool, default=True

Show the plot.

Added in version 0.4.0.

save_figbool, default=False

Save the plot. Used by save_plot_decorator.

Added in version 0.4.0.

save_fig_filenamestr, optional, default=’’

Specify the path and filetype to save the plot. If nothing specified, the plot will be saved as png inside result_images under to the current working directory. Defaults to plot image named to used func.__name__. Used by save_plot_decorator.

Added in version 0.4.0.

overwritebool, optional, default=True

If False and a file exists, auto-increments the filename to avoid overwriting.

Added in version 0.4.0.

add_timestampbool, optional, default=False

Whether to append a timestamp to the filename. Default is False.

Added in version 0.4.0.

verbosebool, optional

If True, enables verbose output with informative messages during execution. Useful for debugging or understanding internal operations such as backend selection, font loading, and file saving status. If False, runs silently unless errors occur.

Default is False.

Added in version 0.4.0: The verbose parameter was added to control logging and user feedback verbosity.

Raises:

ValueError

If investments are zero for any ntile.

_PlotInputError

If plot_input lacks required columns.

Parameters:

• plot_input (DataFrame)

• fixed_costs (float)

• variable_costs_per_unit (float)

• profit_per_unit (float)

• highlight_ntile (int | Sequence[int] | None)

• highlight_how (Literal['plot', 'text', 'plot_text'])

• autopct (str | Callable[[float], str] | None)

• line_kws (Mapping[str, Any] | None)

• ref_line_kws (Mapping[str, Any] | None)

• legend_kws (Mapping[str, Any] | None)

• grid_kws (Mapping[str, Any] | None)

• axes_kws (Mapping[str, Any] | None)

• annotation_kws (Mapping[str, Any] | None)

• footer_kws (Mapping[str, Any] | None)

• save_fig (bool)

• save_fig_filename (str)

• kwargs (Any)

Return type:

Axes

See also

plot_profit, plot_costsrevs

Notes

ROI = profit / investments.

• profit = revenues - investments

• revenues = profit_per_unit * cumpos

• investments = fixed_costs + variable_costs_per_unit * cumtot

Highlight lines use cumulative 1..N semantics and include cumpos / cumtot.

Examples

>>> # ax = plot_roi(plot_input, fixed_costs=100, variable_costs_per_unit=1, profit_per_unit=10)

Gallery examples

Introduction to modelplotpy

Introduction to modelplotpy