From fb42272c816910e9de642a3e6d09c03477891127 Mon Sep 17 00:00:00 2001 From: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Date: Tue, 22 Nov 2022 21:50:59 +0000 Subject: [PATCH] Add clenow and demark to SDK (#3525) * add demark * add clenow * add model examples Co-authored-by: James Maslek --- .../common/technical_analysis/momentum_model.py | 12 ++++++++++++ .../common/technical_analysis/momentum_view.py | 14 +++++++++++++- .../miscellaneous/library/trail_map.csv | 2 ++ 3 files changed, 27 insertions(+), 1 deletion(-) diff --git a/openbb_terminal/common/technical_analysis/momentum_model.py b/openbb_terminal/common/technical_analysis/momentum_model.py index 4c2ba84ddfd..0b8992982c1 100644 --- a/openbb_terminal/common/technical_analysis/momentum_model.py +++ b/openbb_terminal/common/technical_analysis/momentum_model.py @@ -225,6 +225,12 @@ def clenow_momentum( Coefficient of linear regression pd.Series: Values for best fit line + + Examples + -------- + >>> from openbb_terminal.sdk import openbb + >>> df = openbb.stocks.load("AAPL") + >>> openbb.ta.clenow(df["Close"]) """ if len(values) < window: console.print( @@ -260,5 +266,11 @@ def demark_seq(values: pd.Series) -> pd.DataFrame: ------- pd.DataFrame Dataframe of UP and DOWN sequential indicators + + Examples + -------- + >>> from openbb_terminal.sdk import openbb + >>> df = openbb.stocks.load("AAPL") + >>> openbb.ta.demark(df["Close"]) """ return ta.td_seq(values, asint=True) diff --git a/openbb_terminal/common/technical_analysis/momentum_view.py b/openbb_terminal/common/technical_analysis/momentum_view.py index d822087130b..49627d2bce1 100644 --- a/openbb_terminal/common/technical_analysis/momentum_view.py +++ b/openbb_terminal/common/technical_analysis/momentum_view.py @@ -588,6 +588,12 @@ def display_clenow_momentum( Format to export data external_axes : Optional[List[plt.Axes]], optional External axes (2 axes are expected in the list), by default None + + Examples + -------- + >>> from openbb_terminal.sdk import openbb + >>> df = openbb.stocks.load("AAPL") + >>> openbb.ta.clenow_chart(df["Close"]) """ r2, coef, fit_data = momentum_model.clenow_momentum(data, window) @@ -642,7 +648,7 @@ def display_demark( export: str = "", external_axes: Optional[List[plt.Axes]] = None, ): - """Plots demark squential indicator + """Plot demark sequential indicator Parameters ---------- @@ -656,6 +662,12 @@ def display_demark( Format to export data external_axes : Optional[List[plt.Axes]], optional External axes (1 axes are expected in the list), by default None + + Examples + -------- + >>> from openbb_terminal.sdk import openbb + >>> df = openbb.stocks.load("AAPL") + >>> openbb.ta.demark_chart(df) """ close_col = ta_helpers.check_columns(data, high=False, low=False) if close_col is None: diff --git a/openbb_terminal/miscellaneous/library/trail_map.csv b/openbb_terminal/miscellaneous/library/trail_map.csv index 5cc7d8e5fd3..3c9d588ddc1 100644 --- a/openbb_terminal/miscellaneous/library/trail_map.csv +++ b/openbb_terminal/miscellaneous/library/trail_map.csv @@ -64,6 +64,8 @@ ta.fisher,openbb_terminal.common.technical_analysis.momentum_model.fisher,openbb ta.macd,openbb_terminal.common.technical_analysis.momentum_model.macd,openbb_terminal.common.technical_analysis.momentum_view.display_macd ta.rsi,openbb_terminal.common.technical_analysis.momentum_model.rsi,openbb_terminal.common.technical_analysis.momentum_view.display_rsi ta.stoch,openbb_terminal.common.technical_analysis.momentum_model.stoch,openbb_terminal.common.technical_analysis.momentum_view.display_stoch +ta.demark,openbb_terminal.common.technical_analysis.momentum_model.demark_seq,openbb_terminal.common.technical_analysis.momentum_view.display_demark +ta.clenow,openbb_terminal.common.technical_analysis.momentum_model.clenow_momentum,openbb_terminal.common.technical_analysis.momentum_view.display_clenow_momentum ta.ma,openbb_terminal.common.technical_analysis.overlap_view.view_ma,openbb_terminal.common.technical_analysis.overlap_view.view_ma ta.ema,openbb_terminal.common.technical_analysis.overlap_model.ema, ta.hma,openbb_terminal.common.technical_analysis.overlap_model.hma,