asi_core.visualization.timeseries
=================================

.. py:module:: asi_core.visualization.timeseries

.. autoapi-nested-parse::

   This module provides functions to visualize timeseries data.



Functions
---------

.. autoapisummary::

   asi_core.visualization.timeseries.heatmap_missing_data
   asi_core.visualization.timeseries.plot_data_distributions


Module Contents
---------------

.. py:function:: heatmap_missing_data(missing_timestamps, start_date=None, end_date=None, hour_min=6, hour_max=20, y_dim='hour', x_dim='date', title=None, interactive=False)

   Generate a heatmap displaying the distribution of missing data over time.

   :param missing_timestamps: A pandas Series of timestamps representing missing data occurrences.
   :type missing_timestamps: pandas.Series
   :param start_date: The start of the time range for the heatmap. Defaults to the earliest timestamp in `missing_timestamps`.
   :type start_date: str or datetime, optional
   :param end_date: The end of the time range for the heatmap. Defaults to the latest timestamp in `missing_timestamps`.
   :type end_date: str or datetime, optional
   :param hour_min: The minimum hour of the day to include in the heatmap (default is 6).
   :type hour_min: int, optional
   :param hour_max: The maximum hour of the day to include in the heatmap (default is 20).
   :type hour_max: int, optional
   :param y_dim: The variable to use for the y-axis (default is 'hour').
   :type y_dim: str, optional
   :param x_dim: The variable to use for the x-axis (default is 'date').
   :type x_dim: str, optional
   :param title: The title of the heatmap. Defaults to 'Heatmap of Missing Data'.
   :type title: str, optional
   :param interactive: If True, generates an interactive heatmap using `hvplot`; otherwise, generates a static heatmap using `seaborn`.
   :type interactive: bool, optional
   :return: A heatmap figure displaying missing data patterns over time.
   :rtype: matplotlib.figure.Figure or holoviews.element.HeatMap


.. py:function:: plot_data_distributions(df, columns, n_rows, df_ref=None, figsize=(20, 12), title=None)

   Plot histogram of data in subplots.

   :param df: dataframe containing timeseries data.
   :param columns: list of column names.
   :param n_rows: number of rows in figure.
   :param df_ref: reference dataframe (requires the same columns).
   :param figsize: figure size.
   :param title: title of figure.
   :return: figure object.