Files
OpenBB/openbb_terminal/common/technical_analysis/custom_indicators_view.py
Colin Delahunty ee34a1f278 Feature/add isort linter (#4114)
* Fixed isort

* Fixed issues

* FIxed linters

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-02-04 21:24:47 -05:00

148 lines
3.8 KiB
Python

"""Custom TA indicators"""
__docformat__ = "numpy"
import logging
import os
from typing import List, Optional, Union
import matplotlib.pyplot as plt
import pandas as pd
from openbb_terminal.common.technical_analysis import (
custom_indicators_model,
ta_helpers,
)
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_intraday,
is_valid_axes_count,
plot_autoscale,
print_rich_table,
reindex_dates,
)
logger = logging.getLogger(__name__)
@log_start_end(log=logger)
def fibonacci_retracement(
data: pd.DataFrame,
limit: int = 120,
start_date: Optional[Union[str, None]] = None,
end_date: Optional[Union[str, None]] = None,
symbol: str = "",
export: str = "",
sheet_name: str = None,
external_axes: Optional[List[plt.Axes]] = None,
):
"""Plots Calculated fibonacci retracement levels
Parameters
----------
data: pd.DataFrame
OHLC data
limit: int
Days to lookback
start_date: Optional[str, None]
User picked date for starting retracement
end_date: Optional[str, None]
User picked date for ending retracement
symbol: str
Ticker symbol
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 (2 axes are expected in the list), by default None
Examples
--------
>>> from openbb_terminal.sdk import openbb
>>> df = openbb.stocks.load(symbol="aapl")
>>> openbb.ta.fib_chart(data=df)
"""
(
df_fib,
min_date,
max_date,
min_pr,
max_pr,
) = custom_indicators_model.calculate_fib_levels(data, limit, start_date, end_date)
levels = df_fib.Price
plot_data = reindex_dates(data)
# This plot has 2 axes
if external_axes is None:
_, ax1 = plt.subplots(
figsize=plot_autoscale(),
dpi=PLOT_DPI,
)
ax2 = ax1.twinx()
elif is_valid_axes_count(external_axes, 2):
(ax1, ax2) = external_axes
else:
return
close_col = ta_helpers.check_columns(data)
if close_col is None:
return
ax1.plot(plot_data[close_col])
if is_intraday(data):
date_format = "%b %d %H:%M"
else:
date_format = "%Y-%m-%d"
min_date_index = plot_data[
plot_data["date"] == min_date.strftime(date_format)
].index
max_date_index = plot_data[
plot_data["date"] == max_date.strftime(date_format)
].index
ax1.plot(
[min_date_index, max_date_index],
[min_pr, max_pr],
)
for i in levels:
ax1.axhline(y=i, alpha=0.5)
for i in range(6):
ax1.fill_between(plot_data.index, levels[i], levels[i + 1], alpha=0.15)
ax1.set_xlim(plot_data.index[0], plot_data.index[-1])
ax1.set_title(f"Fibonacci Support for {symbol.upper()}")
ax1.set_yticks(levels)
ax1.set_yticklabels([0, 0.235, 0.382, 0.5, 0.618, 0.65, 1])
theme.style_primary_axis(
ax1,
data_index=plot_data.index.to_list(),
tick_labels=plot_data["date"].to_list(),
)
ax2.set_ylim(ax1.get_ylim())
ax2.set_ylabel("Price")
theme.style_primary_axis(ax2)
if external_axes is None:
theme.visualize_output()
print_rich_table(
df_fib,
headers=["Fib Level", "Price"],
show_index=False,
title="Fibonacci retracement levels",
)
export_data(
export,
os.path.dirname(os.path.abspath(__file__)).replace("common", "stocks"),
"fib",
df_fib,
sheet_name,
)