vivainsights.extract_date_range¶

Extract the minimum and maximum date range from a dataset.

vivainsights.extract_date_range.extract_date_range(data, return_type='table')[source]¶

Extract the date range from a DataFrame.

Looks for Date, MetricDate, or StartDate/EndDate columns and returns the minimum and maximum dates.

Parameters:

data (pandas.DataFrame) – DataFrame containing at least one recognised date column.
return_type (str) – "table" (default) returns a single-row DataFrame with Start and End columns; "text" returns a human-readable string.

Returns:

Date range as a table or descriptive string.

Return type:

pandas.DataFrame or str

Examples

>>> import vivainsights as vi
>>> pq_data = vi.load_pq_data()
>>> vi.extract_date_range(pq_data)
>>> vi.extract_date_range(pq_data, return_type="text")