datetime_summary

datetime_summary(data: DataFrame, column: str, fig_height: int = 1000, fig_width: int = 1200, ts_freq: str = 'auto', ts_type: str = 'lines', trend_line: str = 'auto', lower_quantile: float = 0, upper_quantile: float = 1, display_figure: bool = False) Figure

Creates a univariate EDA summary for a datetime data column in a pandas DataFrame.

Parameters
  • data – pandas DataFrame to perform EDA on

  • column – A string matching a column in the data

  • fig_height – Height of the plot in inches

  • fig_width – Width of the plot in inches

  • ts_freq

    String describing the frequency at which to aggregate data in one of two formats:

    • A pandas offset string.

    • A human readable string in the same format passed to date breaks (e.g. “4 months”)

    Default is to attempt to intelligently determine a good aggregation frequency.

  • ts_type – ‘lines’, ‘markers’, or ‘lines+markers’ to plot a line, points, or line + points

  • trend_line

    Trend line to plot over data. “None” produces no trend line. Other options are passed

    to geom_smooth.

    a time period ranging from seconds to years. (e.g. ‘1 year’, ‘3 minutes’)

  • lower_quantile – Lower quantile to filter data above

  • upper_quantile – Upper quantile to filter data below

  • display_figure – Whether to display the figure in addition to returning it