piper.verbs.fmt_dateidx¶
-
piper.verbs.fmt_dateidx(df: pandas.core.frame.DataFrame, freq: str = 'D') → pandas.core.frame.DataFrame[source]¶ format dataframe datelike index
Checks if dataframe index contains a date-like grouper object. If so, applies the ‘frequency’ string given.
Examples
- Parameters
df – dataframe
freq – Default ‘d’ (days) See https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases for list of valid frequency strings.
- Returns
- Return type
A pandas DataFrame