From 81c1bbb34a7d521d137b02ead558bbea0c9e419d Mon Sep 17 00:00:00 2001
From: Anand <anandpillai@letterboxes.org>
Date: Mon, 31 Jul 2023 17:47:54 +0530
Subject: [PATCH] ref issue - 119 - RSI indicator

---
 finquant/momentum_indicators.py | 82 +++++++++++++++++++++++++++++++++
 1 file changed, 82 insertions(+)
 create mode 100644 finquant/momentum_indicators.py

diff --git a/finquant/momentum_indicators.py b/finquant/momentum_indicators.py
new file mode 100644
index 00000000..ded7a624
--- /dev/null
+++ b/finquant/momentum_indicators.py
@@ -0,0 +1,82 @@
+""" This module provides function(s) to compute momentum indicators
+used in technical analysis such as RSI """
+
+import matplotlib.pyplot as plt
+import pandas as pd
+
+def relative_strength_index(data, window_length: int = 14, oversold: int = 30,
+                            overbought: int = 70, standalone: bool = False) -> None:
+    """ Computes and visualizes a RSI graph,
+        plotted along with the prices in another sub-graph
+        for comparison.
+
+     Ref: https://www.investopedia.com/terms/r/rsi.asp
+
+    :Input
+     :data: pandas.Series or pandas.DataFrame with stock prices in columns
+     :window_length: Window length to compute RSI, default being 14 days
+     :oversold: Standard level for oversold RSI, default being 30
+     :overbought: Standard level for overbought RSI, default being 70
+     :standalone: Plot only the RSI graph
+    """
+    if not isinstance(data, (pd.Series, pd.DataFrame)):
+        raise ValueError(
+            "data is expected to be of type pandas.Series or pandas.DataFrame"
+        )
+    if isinstance(data, pd.DataFrame) and not len(data.columns.values) == 1:
+        raise ValueError("data is expected to have only one column.")
+    # checking integer fields
+    for field in (window_length, oversold, overbought):
+        if not isinstance(field, int):
+            raise ValueError(f"{field} must be an integer.")
+    # validating levels
+    if oversold >= overbought:
+        raise ValueError("oversold level should be < overbought level")
+    if oversold >= 100 or overbought >= 100:
+        raise ValueError("levels should be < 100")
+    # converting data to pd.DataFrame if it is a pd.Series (for subsequent function calls):
+    if isinstance(data, pd.Series):
+        data = data.to_frame()
+    # get the stock key
+    stock = data.keys()[0]
+    # calculate price differences
+    data['diff'] = data.diff(1)
+    # calculate gains and losses
+    data['gain'] = data['diff'].clip(lower = 0).round(2)
+    data['loss'] = data['diff'].clip(upper = 0).abs().round(2)
+    # placeholder
+    wl = window_length
+    # calculate rolling window mean gains and losses
+    data['avg_gain'] = data['gain'].rolling(window = wl, min_periods = wl).mean()
+    data['avg_loss'] = data['loss'].rolling(window = wl, min_periods = wl).mean()
+    # calculate WMS (wilder smoothing method) averages
+    for i, row in enumerate(data['avg_gain'].iloc[wl+1:]):
+        data['avg_gain'].iloc[i+wl+1] = (data['avg_gain'].iloc[i+wl]*(wl-1) +data['gain'].iloc[i+wl+1])/wl
+    for i, row in enumerate(data['avg_loss'].iloc[wl+1:]):
+        data['avg_loss'].iloc[i+wl+1] =(data['avg_loss'].iloc[i+wl]*(wl-1) + data['loss'].iloc[i+wl+1])/wl
+    # calculate RS values
+    data['rs'] = data['avg_gain']/data['avg_loss']
+    # calculate RSI
+    data['rsi'] = 100 - (100/(1.0 + data['rs']))
+    # Plot it
+    if standalone:
+        # Single plot
+        fig = plt.figure()
+        ax = fig.add_subplot(111)
+        ax.axhline(y = oversold, color = 'g', linestyle = '--')
+        ax.axhline(y = overbought, color = 'r', linestyle ='--')
+        data['rsi'].plot(ylabel = 'RSI', xlabel = 'Date', ax = ax, grid = True)
+        plt.title("RSI Plot")
+        plt.legend()
+    else:
+        # RSI against price in 2 plots
+        fig, ax = plt.subplots(2, 1, sharex=True, sharey=False)
+        ax[0].axhline(y = oversold, color = 'g', linestyle = '--')
+        ax[0].axhline(y = overbought, color = 'r', linestyle ='--')
+        ax[0].set_title('RSI + Price Plot')
+        # plot 2 graphs in 2 colors
+        colors = plt.rcParams["axes.prop_cycle"]()
+        data['rsi'].plot(ylabel = 'RSI', ax = ax[0], grid = True, color = next(colors)["color"], legend=True)
+        data[stock].plot(xlabel = 'Date', ylabel = 'Price', ax = ax[1], grid = True,
+                         color = next(colors)["color"], legend = True)
+        plt.legend()