Files
pandas-ta/pandas_ta/volume/pvol.py
T

59 lines
1.4 KiB
Python

# -*- coding: utf-8 -*-
from ..utils import get_offset, signed_series, verify_series
def pvol(close, volume, offset=None, **kwargs):
"""Indicator: Price-Volume (PVOL)"""
# Validate arguments
close = verify_series(close)
volume = verify_series(volume)
offset = get_offset(offset)
signed = kwargs.pop('signed', False)
# Calculate Result
if signed:
pvol = signed_series(close, 1) * close * volume
else:
pvol = close * volume
# Offset
if offset != 0:
pvol = pvol.shift(offset)
# Handle fills
if 'fillna' in kwargs:
pvol.fillna(kwargs['fillna'], inplace=True)
if 'fill_method' in kwargs:
pvol.fillna(method=kwargs['fill_method'], inplace=True)
# Name and Categorize it
pvol.name = f"PVOL"
pvol.category = 'volume'
return pvol
pvol.__doc__ = \
"""Price-Volume (PVOL)
Returns a series of the product of price and volume.
Calculation:
if signed:
pvol = signed_series(close, 1) * close * volume
else:
pvol = close * volume
Args:
close (pd.Series): Series of 'close's
volume (pd.Series): Series of 'volume's
signed (bool): Keeps the sign of the difference in 'close's. Default: True
offset (int): How many periods to offset the result. Default: 0
Kwargs:
fillna (value, optional): pd.DataFrame.fillna(value)
fill_method (value, optional): Type of fill method
Returns:
pd.Series: New feature generated.
"""