atualizações das funções de ewma e rolling std

Author: thalissa-reis

turingquant/metrics.py

@@ -225,23 +225,23 @@ def test_metrics():
     print("Sharpe: ", sharpe_ratio(returns))
     print("Beta: ", beta(returns, market))
 
-def ewma_volatility(close_prices,ret,window,plot=True):
+def ewma_volatility(close_prices,return_type,window,plot=True):
     """
     Essa função possibilita a visualização da volatilidade a partir do cálculo da EWMA e da plotagem do gráfico 
     dessa métrica ao longo de um período.
 
     Parâmetros:
         close_prices (pd.DataFrame): série de preços de fechamento que será utilizado de base para o cálculo da EWMA;
-        ret (string): tipo de retorno (simple - 'simp' ou logarítmico - 'log') que será utilizado de base para cálculo;
+        return_type (string): tipo de retorno (simple - 'simp' ou logarítmico - 'log') que será utilizado de base para cálculo;
         window (int): janela móvel para cálculo da EWMA;
         plot (bool): se True, plota o gráfico de linha da EWMA ao longo do tempo
 
     Retorna:
         ewma_volatility (pd.DataFrame): um dataframe indexado à data com os valores de EWMA dos últimos window dias
     """
-    if ret == 'log':
+    if return_type == 'log':
         returns = np.log(close_prices/close_prices.shift(1))
-    elif ret == 'simp':
+    elif return_type == 'simp':
         returns = close_prices.pct_change()
     else:
         raise ValueError("Tipo de retorno inválido")
@@ -256,23 +256,23 @@ def ewma_volatility(close_prices,ret,window,plot=True):
     if plot == False:
         return ewma_volatility
 
-def rolling_std(close_prices,ret,window,plot=True):
+def rolling_std(close_prices,return_type,window,plot=True):
     """
     Essa função possibilita a visualização da volatilidade a partir do cálculo da desvio padrão móvel e da plotagem do gráfico dessa
     métrica ao longo de um período.  
 
     Parâmetros:
         close_prices (pd.DataFrame): série de preços de fechamento que será utilizado de base para o cálculo do desvio padrão móvel;
-        ret (string): tipo de retorno (simple - 'simp' ou logarítmico - 'log') que será utilizado de base para cálculo;
+        return_type (string): tipo de retorno (simple - 'simp' ou logarítmico - 'log') que será utilizado de base para cálculo;
         window (int): janela móvel para cálculo do desvio padrão móvel;
         plot (bool): se True, plota o gráfico de linha do desvio padrão móvel ao longo do tempo
 
     Retorna:
         rolling_std (pd.DataFrame): um dataframe indexado à data com os valores de desvio padrão móvel dos últimos window dias
     """
-    if ret == 'log':
+    if return_type == 'log':
         returns = np.log(close_prices/close_prices.shift(1))
-    elif ret == 'simp':
+    elif return_type == 'simp':
         returns = close_prices.pct_change()
     else:
         raise ValueError("Tipo de retorno inválido")