mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 13:01:38 +00:00
ee34a1f278
* Fixed isort * Fixed issues * FIxed linters --------- Co-authored-by: James Maslek <jmaslek11@gmail.com>
245 lines
7.1 KiB
Python
245 lines
7.1 KiB
Python
"""TA Overlap View"""
|
|
__docformat__ = "numpy"
|
|
|
|
import logging
|
|
import os
|
|
from typing import List, Optional
|
|
|
|
import matplotlib.pyplot as plt
|
|
import mplfinance as mpf
|
|
import pandas as pd
|
|
from pandas.plotting import register_matplotlib_converters
|
|
|
|
from openbb_terminal.common.technical_analysis import overlap_model
|
|
from openbb_terminal.config_plot import PLOT_DPI
|
|
from openbb_terminal.config_terminal import theme
|
|
from openbb_terminal.decorators import log_start_end
|
|
from openbb_terminal.helper_funcs import (
|
|
export_data,
|
|
is_valid_axes_count,
|
|
lambda_long_number_format_y_axis,
|
|
plot_autoscale,
|
|
reindex_dates,
|
|
)
|
|
from openbb_terminal.rich_config import console
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# pylint: disable=too-many-arguments
|
|
|
|
register_matplotlib_converters()
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def view_ma(
|
|
data: pd.Series,
|
|
window: List[int] = None,
|
|
offset: int = 0,
|
|
ma_type: str = "EMA",
|
|
symbol: str = "",
|
|
export: str = "",
|
|
sheet_name: str = None,
|
|
external_axes: Optional[List[plt.Axes]] = None,
|
|
) -> None:
|
|
"""Plots MA technical indicator
|
|
|
|
Parameters
|
|
----------
|
|
data: pd.Series
|
|
Series of prices
|
|
window: List[int]
|
|
Length of EMA window
|
|
offset: int
|
|
Offset variable
|
|
ma_type: str
|
|
Type of moving average. Either "EMA" "ZLMA" or "SMA"
|
|
symbol: str
|
|
Ticker
|
|
sheet_name: str
|
|
Optionally specify the name of the sheet the data is exported to.
|
|
export: str
|
|
Format to export data
|
|
external_axes: Optional[List[plt.Axes]], optional
|
|
External axes (1 axis is expected in the list), by default None
|
|
|
|
Examples
|
|
--------
|
|
>>> from openbb_terminal.sdk import openbb
|
|
>>> df = openbb.stocks.load("AAPL")
|
|
>>> openbb.ta.ma_chart(data=df["Adj Close"], symbol="AAPL", ma_type="EMA", window=[20, 50, 100])
|
|
|
|
|
|
>>> from openbb_terminal.sdk import openbb
|
|
>>> spuk_index = openbb.economy.index(indices = ["^SPUK"])
|
|
>>> openbb.ta.ma_chart(data = spuk_index["^SPUK"], symbol = "S&P UK Index", ma_type = "EMA", window = [20, 50, 100])
|
|
"""
|
|
# Define a dataframe for adding EMA series to it
|
|
price_df = pd.DataFrame(data)
|
|
price_df.index.name = "date"
|
|
|
|
l_legend = [symbol]
|
|
if not window:
|
|
window = [20, 50]
|
|
|
|
for win in window:
|
|
if ma_type == "EMA":
|
|
df_ta = overlap_model.ema(data, win, offset)
|
|
l_legend.append(f"EMA {win}")
|
|
elif ma_type == "SMA":
|
|
df_ta = overlap_model.sma(data, win, offset)
|
|
l_legend.append(f"SMA {win}")
|
|
elif ma_type == "WMA":
|
|
df_ta = overlap_model.wma(data, win, offset)
|
|
l_legend.append(f"WMA {win}")
|
|
elif ma_type == "HMA":
|
|
df_ta = overlap_model.hma(data, win, offset)
|
|
l_legend.append(f"HMA {win}")
|
|
elif ma_type == "ZLMA":
|
|
df_ta = overlap_model.zlma(data, win, offset)
|
|
l_legend.append(f"ZLMA {win}")
|
|
price_df = price_df.join(df_ta)
|
|
|
|
plot_data = reindex_dates(price_df)
|
|
|
|
# This plot has 1 axis
|
|
if external_axes is None:
|
|
_, ax = plt.subplots(figsize=plot_autoscale(), dpi=PLOT_DPI)
|
|
elif is_valid_axes_count(external_axes, 1):
|
|
(ax,) = external_axes
|
|
else:
|
|
return
|
|
|
|
ax.plot(plot_data.index, plot_data.iloc[:, 1].values)
|
|
ax.set_xlim([plot_data.index[0], plot_data.index[-1]])
|
|
ax.set_ylabel(f"{symbol} Price")
|
|
for idx in range(2, plot_data.shape[1]):
|
|
ax.plot(plot_data.iloc[:, idx])
|
|
|
|
ax.set_title(f"{symbol} {ma_type.upper()}")
|
|
ax.legend(l_legend)
|
|
theme.style_primary_axis(
|
|
ax,
|
|
data_index=plot_data.index.to_list(),
|
|
tick_labels=plot_data["date"].to_list(),
|
|
)
|
|
|
|
if external_axes is None:
|
|
theme.visualize_output()
|
|
|
|
export_data(
|
|
export,
|
|
os.path.dirname(os.path.abspath(__file__)).replace("common", "stocks"),
|
|
f"{ma_type.lower()}{'_'.join([str(win) for win in window])}",
|
|
price_df,
|
|
sheet_name,
|
|
)
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def view_vwap(
|
|
data: pd.DataFrame,
|
|
symbol: str = "",
|
|
start_date: Optional[str] = None,
|
|
end_date: Optional[str] = None,
|
|
offset: int = 0,
|
|
interval: str = "",
|
|
export: str = "",
|
|
sheet_name: str = None,
|
|
external_axes: Optional[List[plt.Axes]] = None,
|
|
):
|
|
"""Plots VWMA technical indicator
|
|
|
|
Parameters
|
|
----------
|
|
data : pd.DataFrame
|
|
Dataframe of OHLC prices
|
|
symbol : str
|
|
Ticker
|
|
offset : int
|
|
Offset variable
|
|
start_date: Optional[str]
|
|
Initial date, format YYYY-MM-DD
|
|
end_date: Optional[str]
|
|
Final date, format YYYY-MM-DD
|
|
interval : str
|
|
Interval of data
|
|
export : str
|
|
Format to export data
|
|
external_axes : Optional[List[plt.Axes]], optional
|
|
External axes (3 axes are expected in the list), by default None
|
|
"""
|
|
|
|
data.index = data.index.tz_localize(None)
|
|
|
|
if start_date is None:
|
|
start = data.index[0].date()
|
|
console.print(f"No start date specified. Start date: {start}")
|
|
else:
|
|
start = start_date
|
|
|
|
if end_date is None:
|
|
end = data.index[-1].date()
|
|
console.print(f"No end date specified. End date: {end}")
|
|
else:
|
|
end = end_date
|
|
|
|
day_df = data[(start <= data.index.date) & (data.index.date <= end)]
|
|
if len(day_df) == 0:
|
|
console.print(
|
|
f"[red]No data found between {start.strftime('%Y-%m-%d')} and {end.strftime('%Y-%m-%d')}\n[/red]"
|
|
)
|
|
return
|
|
|
|
df_vwap = overlap_model.vwap(day_df, offset)
|
|
|
|
candle_chart_kwargs = {
|
|
"type": "candle",
|
|
"style": theme.mpf_style,
|
|
"volume": True,
|
|
"xrotation": theme.xticks_rotation,
|
|
"scale_padding": {"left": 0.3, "right": 1.2, "top": 0.8, "bottom": 0.8},
|
|
"update_width_config": {
|
|
"candle_linewidth": 0.6,
|
|
"candle_width": 0.8,
|
|
"volume_linewidth": 0.8,
|
|
"volume_width": 0.8,
|
|
},
|
|
"warn_too_much_data": 10000,
|
|
}
|
|
# This plot has 2 axes
|
|
if external_axes is None:
|
|
candle_chart_kwargs["returnfig"] = True
|
|
candle_chart_kwargs["figratio"] = (10, 7)
|
|
candle_chart_kwargs["figscale"] = 1.10
|
|
candle_chart_kwargs["figsize"] = plot_autoscale()
|
|
candle_chart_kwargs["addplot"] = mpf.make_addplot(
|
|
df_vwap, width=theme.line_width
|
|
)
|
|
fig, ax = mpf.plot(day_df, **candle_chart_kwargs)
|
|
fig.suptitle(
|
|
f"{symbol} {interval} VWAP",
|
|
x=0.055,
|
|
y=0.965,
|
|
horizontalalignment="left",
|
|
)
|
|
lambda_long_number_format_y_axis(day_df, "Volume", ax)
|
|
theme.visualize_output(force_tight_layout=False)
|
|
elif is_valid_axes_count(external_axes, 3):
|
|
(ax1, ax2, ax3) = external_axes
|
|
candle_chart_kwargs["ax"] = ax1
|
|
candle_chart_kwargs["volume"] = ax2
|
|
candle_chart_kwargs["addplot"] = mpf.make_addplot(
|
|
df_vwap, width=theme.line_width, ax=ax3
|
|
)
|
|
mpf.plot(day_df, **candle_chart_kwargs)
|
|
else:
|
|
return
|
|
|
|
export_data(
|
|
export,
|
|
os.path.dirname(os.path.abspath(__file__)).replace("common", "stocks"),
|
|
"VWAP",
|
|
df_vwap,
|
|
sheet_name,
|
|
)
|