pyufunc.group_dt_yearly#

pyufunc.group_dt_yearly(df, interval=1, col=None)#

Group the DataFrame by year.

Parameters:

  • df (pd.DataFrame) – input DataFrame with datetime and value columns

  • interval (int) – the time interval to groupby. Defaults to 1.

  • col (list) – specify input column names. if your input column name is not same as default col name, use your own col name. e.g. [“your_datetime_col_name”, “your_value_col_name”]. Defaults to [“datetime”, “value”].

Returns:

grouped DataFrame by year with count, mean and sum.

Return type:

pd.DataFrame

Example

>>> import pandas as pd
>>> import pyufunc as pf
>>> df = pd.DataFrame({"datetime": pd.date_range(start="2020-01-01",
end="2021-12-31", freq="M"), "value": range(24)})
>>> pf.group_yearly(df, interval=1, col=["datetime", "value"])
The group_yearly require at least two columns
first column: datetime
second column: value
    datetime    count   mean    sum
0       2020-12-31      12          5.5     66
1       2021-12-31      12         17.5     210