pandas.DataFrame.tshift

DataFrame.tshift(periods=1, freq=None, axis=0)[source]

Shift the time index, using the index’s frequency if available.

Deprecated since version 1.1.0: Use shift instead.

Parameters
periods:int

Number of periods to move, can be positive or negative.

freq:DateOffset, timedelta, or str, default None

Increment to use from the tseries module or time rule expressed as a string (e.g. ‘EOM’).

axis:{0 or ‘index’, 1 or ‘columns’, None}, default 0

Corresponds to the axis that contains the Index.

Returns
shifted:Series/DataFrame

Notes

If freq is not specified then tries to use the freq or inferred_freq attributes of the index. If neither of those attributes exist, a ValueError is thrown

© 2008–2021, AQR Capital Management, LLC, Lambda Foundry, Inc. and PyData Development Team
Licensed under the 3-clause BSD License.
https://pandas.pydata.org/pandas-docs/version/1.3.4/reference/api/pandas.DataFrame.tshift.html