Files
pandas-ta/pandas_ta/statistics/median.py
T
2020-10-01 16:18:01 +01:00

52 lines
1.3 KiB
Python

# -*- coding: utf-8 -*-
from ..utils import get_offset, verify_series
def median(close, length=None, offset=None, **kwargs):
"""Indicator: Median"""
# 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)
offset = get_offset(offset)
# Calculate Result
median = close.rolling(length, min_periods=min_periods).median()
# Offset
if offset != 0:
median = median.shift(offset)
# Name & Category
median.name = f"MEDIAN_{length}"
median.category = "statistics"
return median
median.__doc__ = """Rolling Median
Rolling Median of over 'n' periods. Sibling of a Simple Moving Average.
Sources:
https://www.incrediblecharts.com/indicators/median_price.php
Calculation:
Default Inputs:
length=30
MEDIAN = close.rolling(length).median()
Args:
close (pd.Series): Series of 'close's
length (int): It's period. Default: 30
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.
"""