skillcornerviz 1.0.0__py3-none-any.whl

skillcornerviz/standard_plots/bar_plot.py

@@ -0,0 +1,342 @@
+"""
+Liam Bailey
+16/03/2023
+Bar plot
+The plot_bar_chart function is used to generate a bar chart based on the given data.
+It accepts various parameters such as the DataFrame (df) containing the metric data,
+the column to plot on the axis (x_value), labels for the axis (label) and the
+unit of measurement (unit), groups of players to highlight (primary_highlight_group
+and secondary_highlight_group), colors for highlighting (primary_highlight and
+secondary_highlight_color), and other optional customization parameters.
+"""
+import matplotlib.pyplot as plt
+
+from matplotlib.ticker import EngFormatter
+import pandas as pd
+from skillcornerviz.utils.constants import BASE_COLOR, PRIMARY_HIGHLIGHT_COLOR, SECONDARY_HIGHLIGHT_COLOR, \
+    DARK_PRIMARY_HIGHLIGHT_COLOR, DARK_SECONDARY_HIGHLIGHT_COLOR, DARK_BASE_COLOR
+from skillcornerviz.utils.constants import TEXT_COLOR
+from pkg_resources import resource_filename
+from matplotlib import font_manager as fm
+import matplotlib.patheffects as pe
+
+fonts = ['resources/Roboto/Roboto-Black.ttf',
+         'resources/Roboto/Roboto-BlackItalic.ttf',
+         'resources/Roboto/Roboto-Bold.ttf',
+         'resources/Roboto/Roboto-BoldItalic.ttf',
+         'resources/Roboto/Roboto-Italic.ttf',
+         'resources/Roboto/Roboto-Light.ttf',
+         'resources/Roboto/Roboto-LightItalic.ttf',
+         'resources/Roboto/Roboto-Medium.ttf',
+         'resources/Roboto/Roboto-MediumItalic.ttf',
+         'resources/Roboto/Roboto-Regular.ttf',
+         'resources/Roboto/Roboto-Thin.ttf',
+         'resources/Roboto/Roboto-ThinItalic.ttf']
+
+for f in fonts:
+    filepath = resource_filename('skillcornerviz', f)
+    fm.fontManager.addfont(filepath)
+plt.rcParams["font.family"] = "Roboto"
+
+
+def plot_bar_chart(df,
+                   metric,
+                   label=None,
+                   unit=None,
+                   primary_highlight_group=None,
+                   secondary_highlight_group=None,
+                   primary_highlight_color=PRIMARY_HIGHLIGHT_COLOR,
+                   secondary_highlight_color=SECONDARY_HIGHLIGHT_COLOR,
+                   data_point_id='player_name',
+                   data_point_label='player_name',
+                   plot_title=None,
+                   base_color=BASE_COLOR,
+                   add_bar_values=False,
+                   figsize=(8, 4),
+                   lim=None,
+                   order=None,
+                   vertical=False,
+                   rotation=90,
+                   fontsize=7,
+                   dark_mode=False):
+    """
+    Plot a bar chart using the given data.
+
+    Parameters
+    ----------
+    df : DataFrame
+        Metric DataFrame.
+    metric : str
+        The column in df we want to plot on the x-axis.
+    label : str, optional
+        The label for the x-axis. This should reflect what the x_value is.
+    unit : str, optional
+        If we want to add a unit to the axis values. For example % or km/h.
+    primary_highlight_group : list, optional
+        A group of players to label & highlight in Primary Color
+    secondary_highlight_group : list, optional
+        A group of players to label & highlight in Secondary Color.
+    primary_highlight_color : str, optional
+        The color for primary highlighted players (default: 'PHYSICAL PITCH').
+    secondary_highlight_color : str, optional
+        The color for secondary highlighted players (default: 'PHYSICAL PITCH S60' from SkillCorner's Palette).
+    data_point_id : str, optional
+        The identifier column for each data point (default: 'player_name').
+    data_point_label : str, optional
+        The label column for each data point (default: 'player_name').
+    plot_title : str, optional
+        The title of the plot.
+    base_color : str, optional
+        The base color for the bars (default: 'INNOVATION' from SkillCorner's Palette).
+    figsize : tuple, optional
+        Tuple (x, y) that defines the dimensions of the figure (default: (8, 4)).
+    lim: tuple, optional
+       Tuple (x, y) that defines the axis limits
+    order : list, optional
+        List that orders the axis (dimensional data) (default: None)
+    vertical: bool, optional
+        Orients the chart vertically or horizontally. (default: False)
+    rotation: int, optional
+        Rotates the labels if vertical=True is used. (default: 90)
+    fontsize: int, optional
+        Sets the fontsize used for texts.
+
+    Returns
+    -------
+    fig : matplotlib.figure.Figure
+        The generated figure.
+    ax : matplotlib.axes.Axes
+        The generated axes.
+
+    """
+    # Error Handling
+
+    if metric not in df.columns:
+        raise ValueError("The metric you have entered is not in the DataFrame")
+
+
+    if dark_mode:
+        background_color = TEXT_COLOR
+        primary_highlight_color = DARK_PRIMARY_HIGHLIGHT_COLOR
+        secondary_highlight_color = DARK_SECONDARY_HIGHLIGHT_COLOR
+        text_color = 'white'
+        edge_color = None
+    else:
+        background_color = 'white'
+        text_color = TEXT_COLOR
+        edge_color = None
+
+    if label is None:
+        label = unit
+
+    # Setting the font to our SkillCorner font.
+    if primary_highlight_group is None:
+        primary_highlight_group = []
+    if secondary_highlight_group is None:
+        secondary_highlight_group = []
+
+    # Setting plot size & background.
+    fig, ax = plt.subplots(figsize=figsize)
+    fig.patch.set_facecolor(background_color)
+    ax.set_facecolor(background_color)
+
+    # Sorting the dataframe based on the metric to plot.
+    if order is None:
+        if not vertical:
+            df = df.sort_values(by=metric)
+        else:
+            df = df.sort_values(by=metric, ascending=False)
+    else:
+        df[data_point_id] = pd.Categorical(df[data_point_id], categories=order, ordered=True)
+        df = df.sort_values(data_point_id)
+    y_pos = range(0, len(df))
+
+    # Plotting bars.
+    if not vertical:
+        bars = ax.barh(y_pos,
+                       df[metric],
+                       color=DARK_BASE_COLOR if dark_mode else BASE_COLOR,
+                       edgecolor=edge_color,
+                       lw=0.5,
+                       zorder=3,
+                       alpha=1
+                       # alpha=0.1 if dark_mode is True, else alpha=1
+                       )
+        # Looping through data & bars to highlight specific players.
+        for i, bar in zip(y_pos, bars):
+            # If the player has been included in the comparison_players or target_players
+            if df[data_point_id].iloc[i] in secondary_highlight_group or \
+                    df[data_point_id].iloc[i] in primary_highlight_group:
+                bar.set_color(secondary_highlight_color)
+                bar.set_alpha(1)
+
+                # If the player has been included in the target_players
+                if df[data_point_id].iloc[i] in primary_highlight_group:
+                    bar.set_color(primary_highlight_color)
+
+                # Apply to all bars.
+                bar.set_edgecolor(edge_color)
+                bar.set_linewidth(0.5)
+
+                if add_bar_values:
+                    if unit is not None:
+                        # If a unit has been given, a string with the rounded value is created, including the unit
+                        str_value = str(round(df[metric].iloc[i], 2)) + ' ' + unit + '  '
+                    else:
+                        # If a unit is not given, only the rounded string is created
+                        str_value = str(round(df[metric].iloc[i], 2)) + '  '
+
+                    # Adding the str_value to the plot
+                    ax.text(df[metric].iloc[i], i, str_value,
+                            # Stylistic features for the plot
+                            ha='right', va='center',
+                            fontsize=fontsize, fontweight='bold',
+                            color=background_color if dark_mode else 'white',
+                            path_effects=[pe.withStroke(linewidth=.75,
+                                                        foreground=text_color,
+                                                        alpha=1)])
+            else:
+                if add_bar_values:
+                    if unit is not None:
+                        # If a unit has been given, a string with the rounded value is created, including the unit
+                        str_value = str(round(df[metric].iloc[i], 2)) + ' ' + unit + '  '
+                    else:
+                        # If a unit is not given, only the rounded string is created
+                        str_value = str(round(df[metric].iloc[i], 2)) + '  '
+
+                    # Adding the str_value to the plot
+                    ax.text(df[metric].iloc[i], i, str_value,
+                            # Stylistic features for the plot
+                            ha='right', va='center',
+                            fontsize=fontsize, fontweight='bold',
+                            color=text_color,
+                            path_effects=[pe.withStroke(linewidth=.75,
+                                                        foreground=background_color if dark_mode else 'white',
+                                                        alpha=1)])
+
+        # Setting plot elements to #0C1B37.
+        ax.spines['left'].set_color(text_color)
+        ax.spines['bottom'].set_color(None)
+        # Setting y ticks to player names.
+        ax.set_yticks(y_pos)
+        ax.set_yticklabels(df[data_point_label])
+
+        # Setting player names for those in comparison or target groups to bold.
+        for i, tick_label in enumerate(ax.get_yticklabels()):
+            if df[data_point_id].iloc[i] in secondary_highlight_group or \
+                    df[data_point_id].iloc[i] in primary_highlight_group:
+                tick_label.set_fontproperties({'weight': 'bold', 'size': fontsize})
+            else:
+                tick_label.set_fontproperties({'size': fontsize})
+
+        # If a unit has been specified, apply it to the x-axis.
+        if unit is not None:
+            formatter0 = EngFormatter(unit=unit)
+            ax.xaxis.set_major_formatter(formatter0)
+        # Setting x label.
+        ax.set_xlabel(label,
+                      fontweight='bold',
+                      fontsize=fontsize,
+                      labelpad=8)
+        # If you give a lim we set it
+        if lim is not None:
+            ax.set_xlim(lim)
+
+    elif vertical:
+        bars = ax.bar(y_pos,
+                      df[metric],
+                      color=base_color,
+                      edgecolor=text_color,
+                      lw=0.5,
+                      zorder=3,
+                      alpha=1)
+        # Looping through data & bars to highlight specific players.
+        for i, bar in zip(y_pos, bars):
+            # If the player has been included in the comparison_players or target_players
+            if df[data_point_id].iloc[i] in secondary_highlight_group or \
+                    df[data_point_id].iloc[i] in primary_highlight_group:
+                bar.set_color(secondary_highlight_color)
+
+                # If the player has been included in the target_players
+                if df[data_point_id].iloc[i] in primary_highlight_group:
+                    bar.set_color(primary_highlight_color)
+
+                # Apply to all bars.
+                bar.set_edgecolor(text_color)
+                bar.set_linewidth(0.5)
+
+            if add_bar_values:
+                if unit is not None:
+                    str_value = str(round(df[metric].iloc[i], 2)) + ' ' + unit
+                else:
+                    str_value = str(round(df[metric].iloc[i], 2))
+
+                ax.text(i, df[metric].iloc[i], str_value,
+                        ha='center', va='bottom',
+                        fontsize=fontsize, fontweight='bold',
+                        color=text_color,
+                        path_effects=[pe.withStroke(linewidth=.75,
+                                                    foreground='white',
+                                                    alpha=1)])
+
+        # Setting plot elements to #0C1B37.
+        ax.spines['left'].set_color(None)
+        ax.spines['bottom'].set_color(text_color)
+
+        # Setting y ticks to player names.
+        ax.set_xticks(y_pos)
+        ax.set_xticklabels(df[data_point_label], rotation=rotation)
+
+        # Setting player names for those in comparison or target groups to bold.
+        for i, tick_label in enumerate(ax.get_xticklabels()):
+            if df[data_point_id].iloc[i] in secondary_highlight_group or \
+                    df[data_point_id].iloc[i] in primary_highlight_group:
+                tick_label.set_fontproperties({'weight': 'bold', 'size': fontsize})
+            else:
+                tick_label.set_fontproperties({'size': fontsize})
+
+        # If a unit has been specified, apply it to the x-axis.
+        if unit is not None:
+            formatter0 = EngFormatter(unit=unit)
+            ax.yaxis.set_major_formatter(formatter0)
+        # Setting x label.
+        ax.set_ylabel(label,
+                      fontweight='bold',
+                      fontsize=fontsize)
+        # If you give a lim we set it
+        if lim is not None:
+            ax.set_ylim(lim)
+
+    # Hiding the top & right spines.
+    ax.spines['top'].set_color('none')
+    ax.spines['right'].set_color('none')
+
+    # Setting axis label style params.
+    ax.tick_params(axis='x',
+                   colors=text_color,
+                   labelsize=fontsize,
+                   length=0)
+    ax.tick_params(axis='y',
+                   colors=text_color,
+                   labelsize=fontsize)
+
+    ax.yaxis.label.set_color(text_color)
+    ax.xaxis.label.set_color(text_color)
+
+    # Add grid.
+    ax.grid(color=text_color,
+            axis='both',
+            linestyle='--',
+            linewidth=0.5,
+            alpha=0.25,
+            zorder=1)
+
+    if plot_title is not None:
+        ax.set_title(plot_title, fontweight='normal', color=text_color)
+
+    for k, spine in ax.spines.items():
+        spine.set_zorder(10)
+    plt.tight_layout()
+    plt.show()
+
+    return fig, ax

skillcornerviz/standard_plots/formating.py

@@ -0,0 +1,92 @@
+"""
+Michael Nanopoulos
+Simple function that takes an ax, x , and y
+
+"""
+
+from matplotlib.ticker import EngFormatter
+from skillcornerviz.utils.constants import TEXT_COLOR
+
+
+def standard_ax_formating(ax,
+                          x_label,
+                          y_label,
+                          x_unit=None,
+                          y_unit=None,
+                          labelsize=7,
+                          fontsize=7,
+                          show_legend=True,
+                          legend_fontsize=6,
+                          show_left_spine=False,
+                          dark_mode=False):
+    """
+    Function to format the appearance of a matplotlib axis in a standardized way.
+
+    Args:
+        ax (matplotlib.axis.Axis): The axis object to be formatted.
+        x_label (str): The label for the x-axis.
+        y_label (str): The label for the y-axis.
+        x_unit (str, optional): The unit for the values on the x-axis.
+        y_unit (str, optional): The unit for the values on the y-axis.
+        labelsize (int, optional): The font size of the axis labels.
+        fontsize (int, optional): The font size of the tick labels on the axes.
+        show_legend (bool, optional): Whether to show the legend on the plot.
+        legend_fontsize (int, optional): The font size of the legend labels.
+        show_left_spine (bool, optional): Whether to show the left spine of the plot.
+    """
+
+    color = 'white' if dark_mode else TEXT_COLOR
+    # Set x-axis label properties
+    ax.set_xlabel(x_label, fontweight='bold', fontsize=labelsize, color=color)
+    # Set y-axis label properties
+    ax.set_ylabel(y_label, fontweight='bold', fontsize=labelsize, color=color)
+
+    # Set spine colors
+    ax.spines['bottom'].set_color(color)
+    ax.spines['top'].set_color('none')
+    ax.spines['right'].set_color('none')
+    ax.spines['left'].set_color('none')
+    if show_left_spine:
+        ax.spines['left'].set_color(color)
+
+    # Set tick parameters for x-axis and y-axis
+    ax.tick_params(axis='x', colors=color, labelsize=fontsize)
+    ax.tick_params(axis='y', colors=color, labelsize=fontsize, length=0)
+
+    # Add legend if show_legend is True
+    if show_legend:
+        ax.legend(facecolor=TEXT_COLOR if dark_mode else 'white',
+                  edgecolor=TEXT_COLOR if dark_mode else 'white',
+                  framealpha=0.6,
+                  labelcolor=color,
+                  fontsize=legend_fontsize,
+                  loc='center left',
+                  bbox_to_anchor=(1.01, 0.5))
+
+    # Format x-axis tick labels with the specified unit
+    if x_unit is not None:
+        formatter0 = EngFormatter(unit=x_unit)
+        ax.xaxis.set_major_formatter(formatter0)
+
+    # Format y-axis tick labels with the specified unit
+    if y_unit is not None:
+        formatter1 = EngFormatter(unit=y_unit)
+        ax.yaxis.set_major_formatter(formatter1)
+
+
+def prep_label_for_radar(x):
+    label = x.lower().replace('count_', '').replace('_p90', '').replace(' P90', ''). \
+        replace('_per_30_tip', ' ').replace('runs', '').replace('opportunities_to_pass_to_', '').replace('_', ' '). \
+        strip().upper()
+    return label
+
+
+def simplify_label(x):
+    label = x.lower().replace('carrera a ', '').replace('carrera de ', '').replace('carrera para ', '').replace('carrera',
+                                                                                                             '').replace(' por ','\n'). \
+        replace('course pour ', '').replace('course de ', '').replace('course', ''). \
+        replace('être à la', '').replace('dans la ', '').replace('dans le ', ''). \
+        replace('corsa ', '').\
+        replace('runs', ''). \
+        strip().upper()
+    return label