BPt.Dataset.tshift#
- Dataset.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
- periodsint
Number of periods to move, can be positive or negative.
- freqDateOffset, 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. For Series this parameter is unused and defaults to 0.
- Returns
- shiftedSeries/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