mirror of
https://github.com/wassname/pandas-ta.git
synced 2026-06-27 16:10:07 +08:00
James Sawyer
51 lines
1.3 KiB
Python
51 lines
1.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
from ..utils import get_offset, verify_series
|
|
|
|
|
|
def quantile(close, length=None, q=None, offset=None, **kwargs):
|
|
"""Indicator: Quantile"""
|
|
# Validate Arguments
|
|
close = verify_series(close)
|
|
length = int(length) if length and length > 0 else 30
|
|
min_periods = (int(kwargs["min_periods"]) if "min_periods" in kwargs and
|
|
kwargs["min_periods"] is not None else length)
|
|
q = float(q) if q and q > 0 and q < 1 else 0.5
|
|
offset = get_offset(offset)
|
|
|
|
# Calculate Result
|
|
quantile = close.rolling(length, min_periods=min_periods).quantile(q)
|
|
|
|
# Offset
|
|
if offset != 0:
|
|
quantile = quantile.shift(offset)
|
|
|
|
# Name & Category
|
|
quantile.name = f"QTL_{length}_{q}"
|
|
quantile.category = "statistics"
|
|
|
|
return quantile
|
|
|
|
|
|
quantile.__doc__ = """Rolling Quantile
|
|
|
|
Sources:
|
|
|
|
Calculation:
|
|
Default Inputs:
|
|
length=30, q=0.5
|
|
QUANTILE = close.rolling(length).quantile(q)
|
|
|
|
Args:
|
|
close (pd.Series): Series of 'close's
|
|
length (int): It's period. Default: 30
|
|
q (float): The quantile. Default: 0.5
|
|
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.
|
|
"""
|