.. _f-plothelper:

module ``plotting.plot_helper``
===============================







Short summary
+++++++++++++

module ``pymlbenchmark.plotting.plot_helper``

Plotting helpers


:githublink:`%|py|5`






Functions
+++++++++

+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| function                                                                               | truncated documentation                                                                                                    |
+========================================================================================+============================================================================================================================+
| :func:`ax_position <pymlbenchmark.plotting.plot_helper.ax_position>`                   | :epkg:`matplotlib` uses a one dimension array if the number of columns or rows is 1. This function makes a correction. ... |
+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`filter_df_options <pymlbenchmark.plotting.plot_helper.filter_df_options>`       | Filters out rows from a dataframe.                                                                                         |
+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`list_col_options <pymlbenchmark.plotting.plot_helper.list_col_options>`         |                                                                                                                            |
+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`move_color <pymlbenchmark.plotting.plot_helper.move_color>`                     | Returns a different colors, lighter or darker.                                                                             |
+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`move_color_add <pymlbenchmark.plotting.plot_helper.move_color_add>`             | Makes color lighter or darker based on a style.                                                                            |
+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`options2label <pymlbenchmark.plotting.plot_helper.options2label>`               | Converts a list of options into a label.                                                                                   |
+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`plt_colors <pymlbenchmark.plotting.plot_helper.plt_colors>`                     | Returns :epkg:`matplotlib` colors.                                                                                         |
+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`plt_styles <pymlbenchmark.plotting.plot_helper.plt_styles>`                     | Returns :epkg:`matplotlib` styles.                                                                                         |
+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`remove_common_prefix <pymlbenchmark.plotting.plot_helper.remove_common_prefix>` | Removes the common prefix of a series of labels.                                                                           |
+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: pymlbenchmark.plotting.plot_helper
    :members:
    :special-members: __init__
    :show-inheritance: