Files
OpenBB/gamestonk_terminal/common/technical_analysis/trend_indicators_model.py
LBolte29 6426b76771 decorated functions (#1282)
* decorated functions and removed assertion tests that are now caught by decorator logs
* modified functions with @property
* fixed bc of coingecko
* fixed outedated tests
2022-01-31 20:37:16 +01:00

88 lines
1.7 KiB
Python

"""Trend Indicators Technical Analysis Model"""
__docformat__ = "numpy"
import logging
import pandas as pd
import pandas_ta as ta
from gamestonk_terminal.decorators import log_start_end
logger = logging.getLogger(__name__)
@log_start_end(log=logger)
def adx(
high_values: pd.Series,
low_values: pd.Series,
close_values: pd.Series,
length: int = 14,
scalar: int = 100,
drift: int = 1,
):
"""ADX technical indicator
Parameters
----------
high_values: pd.Series
High prices
low_values: pd.Series
Low prices
close_values: pd.Series
close prices
length: int
Length of window
scalar: int
Scalar variable
drift: int
Drift variable
Returns
-------
pd.DataFrame
DataFrame with adx indicator
"""
return pd.DataFrame(
ta.adx(
high=high_values,
low=low_values,
close=close_values,
length=length,
scalar=scalar,
drift=drift,
).dropna()
)
@log_start_end(log=logger)
def aroon(
high_values: pd.Series, low_values: pd.Series, length: int = 25, scalar: int = 100
) -> pd.DataFrame:
"""Aroon technical indicator
Parameters
----------
high_values: pd.Series
High prices
low_values: pd.Series
Low prices
length : int
Length of window
scalar : int
Scalar variable
Returns
-------
pd.DataFrame
DataFrame with aroon indicator
"""
return pd.DataFrame(
ta.aroon(
high=high_values,
low=low_values,
length=length,
scalar=scalar,
).dropna()
)