direl-ts-tool-kit 0.6.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

direl_ts_tool_kit/plot/plot_ts.py

@@ -412,3 +412,62 @@ def pair_plot(X, y):
     fig = svm.fig
 
     return fig
+
+
+def plot_histogram(df, variable, units="", density=True, color="BLUE_BARS", bins=30):
+    """
+    Generates a histogram plot for a specified numerical variable.
+
+    The plot visualizes the distribution of the data, with the Y-axis dynamically
+    labeled as 'Density' or 'Count' based on the `density` parameter.
+
+    Parameters
+    ----------
+    df : pd.DataFrame
+        The DataFrame containing the data to be plotted.
+    variable : str
+        The name of the column in 'df' whose distribution will be plotted.
+    units : str, optional
+        Units to display next to the variable name on the X-axis. Defaults to "".
+    density : bool, optional
+        If True (default), the Y-axis is scaled to a Probability Density,
+        meaning the area under the bars sums to 1. If False, the Y-axis
+        displays the raw count of observations per bin.
+    color : str, optional
+        Key corresponding to the bar color in the global 'paper_colors' dictionary
+        (e.g., "BLUE_BARS"). Defaults to "BLUE_LINES".
+    bins : int or sequence, optional
+        The number of equal-width bins in the range to divide the data.
+        Can be an integer (default is 30) or a sequence specifying the bin edges.
+
+    Returns
+    -------
+    matplotlib.figure.Figure
+        The generated Matplotlib Figure object containing the histogram.
+
+    Notes
+    -----
+    The plot applies a fixed style (alpha=0.7, white edge-color) and grid
+    for visual consistency.
+    """
+    fig, ax = plt.subplots()
+
+    ax.hist(
+        df[variable],
+        bins=bins,
+        density=density,
+        alpha=0.7,
+        color=paper_colors[color],
+        edgecolor="white",
+    )
+
+    ax.set_xlabel(f"{variable} {units}")
+
+    if density:
+        ax.set_ylabel("Density")
+    else:
+        ax.set_ylabel("Count")
+
+    ax.grid(alpha=0.8, linestyle="--")
+
+    return fig

{direl_ts_tool_kit-0.6.0.dist-info → direl_ts_tool_kit-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: direl-ts-tool-kit
-Version: 0.6.0
+Version: 0.7.0
 Summary: A toolbox for time series analysis and visualization.
 Home-page: https://gitlab.com/direl/direl_tool_kit
 Author: Diego Restrepo-Leal
@@ -125,6 +125,14 @@ It focuses on the lower triangular part (corner=True) and includes a
 regression line for trend visualization.
 
 
+#### plot_histogram
+`plot_histogram(df, variable, units="", density=True, color="BLUE_BARS", bins=30)`
+
+Generates a histogram plot for a specified numerical variable.
+
+The plot visualizes the distribution of the data, with the Y-axis dynamically
+labeled as 'Density' or 'Count' based on the `density` parameter.
+
 # Examples
 - [Example 1](https://gitlab.com/direl/direl_tool_kit/-/blob/main/example/example_01.md?ref_type=heads)
 - [Example 2](https://gitlab.com/direl/direl_tool_kit/-/blob/main/example/example_02.md?ref_type=heads)

{direl_ts_tool_kit-0.6.0.dist-info → direl_ts_tool_kit-0.7.0.dist-info}/RECORD

@@ -1,11 +1,11 @@
 direl_ts_tool_kit/__init__.py,sha256=W99Wd3BeEFKOxT51TApURElbDJvqIjD8u_-qDoCYSJ0,94
 direl_ts_tool_kit/plot/__init__.py,sha256=CMwyv-kiE74nwr3MJPL7gWIJmcfZ8UQCRu7mBGGQ4rI,49
 direl_ts_tool_kit/plot/plot_style.py,sha256=5YxoLXlYvzleTnBEGPwCmHQIJ0S96KPJspq_n-qMvpw,1069
-direl_ts_tool_kit/plot/plot_ts.py,sha256=D1doDV24eKOFD7vxZUE6QRx-kTRPPjmbxcGOnvdVjKQ,12982
+direl_ts_tool_kit/plot/plot_ts.py,sha256=E8oswirgUyzojKRvUA39MiZqplCFMMmIJtYBDOOM4JM,14839
 direl_ts_tool_kit/utilities/__init__.py,sha256=jMtxYZUtwlhgI99sxe_8MMzsDnxtbTP7Ivh9tUOeIwQ,25
 direl_ts_tool_kit/utilities/data_prep.py,sha256=k3eOwQEEd5mxy2DtT_Gdo7BhkzEmSQqvMJ89y8mH5CQ,6024
-direl_ts_tool_kit-0.6.0.dist-info/licenses/LICENCE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-direl_ts_tool_kit-0.6.0.dist-info/METADATA,sha256=4G6DKqzMbNny1JE26bGSUuX5zpDqf-4VDuvjwgMZjLI,4883
-direl_ts_tool_kit-0.6.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-direl_ts_tool_kit-0.6.0.dist-info/top_level.txt,sha256=vMCRudnGnsdRg_6fUftnG8PF2Y1m0bjBDMf3pCAp6bc,18
-direl_ts_tool_kit-0.6.0.dist-info/RECORD,,
+direl_ts_tool_kit-0.7.0.dist-info/licenses/LICENCE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+direl_ts_tool_kit-0.7.0.dist-info/METADATA,sha256=UTxeb67A2nbjkUDpPd2tAP_7GgEc4KRmaawwDz2fzG4,5196
+direl_ts_tool_kit-0.7.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+direl_ts_tool_kit-0.7.0.dist-info/top_level.txt,sha256=vMCRudnGnsdRg_6fUftnG8PF2Y1m0bjBDMf3pCAp6bc,18
+direl_ts_tool_kit-0.7.0.dist-info/RECORD,,