openseries 1.2.2__py3-none-any.whl → 1.2.4__py3-none-any.whl

openseries/common_model.py

@@ -1,14 +1,13 @@
-"""
-Defining the CommonModel class
-"""
+"""Defining the CommonModel class."""
 import datetime as dt
 from json import dump
+from math import ceil
+from os import path
 from pathlib import Path
 from random import choices
 from string import ascii_letters
-from os import path
-from typing import Any, cast, Optional, TypeVar, Union
-from math import ceil
+from typing import Any, Optional, TypeVar, Union, cast
+
 from numpy import cumprod, log, sqrt
 from openpyxl import Workbook
 from openpyxl.utils.dataframe import dataframe_to_rows
@@ -17,24 +16,25 @@ from plotly.graph_objs import Figure
 from plotly.offline import plot
 from scipy.stats import kurtosis, norm, skew
 
+from openseries.datefixer import get_calc_range
+from openseries.load_plotly import load_plotly_dict
 from openseries.risk import cvar_down_calc, drawdown_series, var_down_calc
 from openseries.types import (
     LiteralBarPlotMode,
     LiteralLinePlotMode,
-    LiteralPlotlyOutput,
     LiteralNanMethod,
+    LiteralPlotlyOutput,
+    LiteralQuantileInterp,
     ValueType,
 )
-from openseries.load_plotly import load_plotly_dict
-from openseries.datefixer import get_calc_range
-from openseries.types import LiteralQuantileInterp
-
 
 TypeCommonModel = TypeVar("TypeCommonModel", bound="CommonModel")
 
 
 class CommonModel:
-    """CommonModel declared
+
+    """
+    CommonModel declared.
 
     Parameters
     ----------
@@ -47,73 +47,80 @@ class CommonModel:
     @property
     def length(self: TypeCommonModel) -> int:
         """
+        Number of observations.
+
         Returns
         -------
         int
             Number of observations
         """
-
         return len(self.tsdf.index)
 
     @property
     def first_idx(self: TypeCommonModel) -> dt.date:
         """
+        The first date in the timeseries.
+
         Returns
         -------
         datetime.date
             The first date in the timeseries
         """
-
         return cast(dt.date, self.tsdf.index[0])
 
     @property
     def last_idx(self: TypeCommonModel) -> dt.date:
         """
+        The last date in the timeseries.
+
         Returns
         -------
         datetime.date
             The last date in the timeseries
         """
-
         return cast(dt.date, self.tsdf.index[-1])
 
     @property
     def span_of_days(self: TypeCommonModel) -> int:
         """
+        Number of days from the first date to the last.
+
         Returns
         -------
         int
             Number of days from the first date to the last
         """
-
         return (self.last_idx - self.first_idx).days
 
     @property
     def yearfrac(self: TypeCommonModel) -> float:
         """
+        Length of series expressed in years assuming all years have 365.25 days.
+
         Returns
         -------
         float
             Length of the timeseries expressed in years assuming all years
             have 365.25 days
         """
-
         return self.span_of_days / 365.25
 
     @property
     def periods_in_a_year(self: TypeCommonModel) -> float:
         """
+        The average number of observations per year.
+
         Returns
         -------
         float
             The average number of observations per year
         """
-
         return self.length / self.yearfrac
 
     @property
     def max_drawdown_cal_year(self: TypeCommonModel) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/m/maximum-drawdown-mdd.asp
+        """
+        https://www.investopedia.com/terms/m/maximum-drawdown-mdd.asp.
 
         Returns
         -------
@@ -125,7 +132,7 @@ class CommonModel:
             self.tsdf.groupby(years)
             .apply(
                 lambda prices: (prices / prices.expanding(min_periods=1).max()).min()
-                - 1
+                - 1,
             )
             .min()
         )
@@ -137,7 +144,8 @@ class CommonModel:
 
     @property
     def geo_ret(self: TypeCommonModel) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/c/cagr.asp
+        """
+        https://www.investopedia.com/terms/c/cagr.asp.
 
         Returns
         -------
@@ -148,19 +156,21 @@ class CommonModel:
 
     @property
     def arithmetic_ret(self: TypeCommonModel) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/a/arithmeticmean.asp
+        """
+        https://www.investopedia.com/terms/a/arithmeticmean.asp.
 
         Returns
         -------
         Union[float, Pandas.Series]
             Annualized arithmetic mean of returns
         """
-
         return self.arithmetic_ret_func()
 
     @property
     def value_ret(self: TypeCommonModel) -> Union[float, Series]:
         """
+        Simple return.
+
         Returns
         -------
         Union[float, Pandas.Series]
@@ -170,9 +180,11 @@ class CommonModel:
 
     @property
     def vol(self: TypeCommonModel) -> Union[float, Series]:
-        """Based on Pandas .std() which is the equivalent of stdev.s([...])
-        in MS Excel \n
-        https://www.investopedia.com/terms/v/volatility.asp
+        """
+        Annualized volatility.
+
+        Based on Pandas .std() which is the equivalent of stdev.s([...]) in MS Excel.
+        https://www.investopedia.com/terms/v/volatility.asp.
 
         Returns
         -------
@@ -183,10 +195,12 @@ class CommonModel:
 
     @property
     def downside_deviation(self: TypeCommonModel) -> Union[float, Series]:
-        """The standard deviation of returns that are below a Minimum Accepted
-        Return of zero.
-        It is used to calculate the Sortino Ratio \n
-        https://www.investopedia.com/terms/d/downside-deviation.asp
+        """
+        Downside Deviation.
+
+        Standard deviation of returns that are below a Minimum Accepted Return
+        of zero. It is used to calculate the Sortino Ratio.
+        https://www.investopedia.com/terms/d/downside-deviation.asp.
 
         Returns
         -------
@@ -199,6 +213,8 @@ class CommonModel:
     @property
     def ret_vol_ratio(self: TypeCommonModel) -> Union[float, Series]:
         """
+        Ratio of annualized arithmetic mean of returns and annualized volatility.
+
         Returns
         -------
         Union[float, Pandas.Series]
@@ -210,7 +226,8 @@ class CommonModel:
 
     @property
     def sortino_ratio(self: TypeCommonModel) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/s/sortinoratio.asp
+        """
+        https://www.investopedia.com/terms/s/sortinoratio.asp.
 
         Returns
         -------
@@ -222,23 +239,26 @@ class CommonModel:
         riskfree_rate: float = 0.0
         minimum_accepted_return: float = 0.0
         return self.sortino_ratio_func(
-            riskfree_rate=riskfree_rate, min_accepted_return=minimum_accepted_return
+            riskfree_rate=riskfree_rate,
+            min_accepted_return=minimum_accepted_return,
         )
 
     @property
     def z_score(self: TypeCommonModel) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/z/zscore.asp
+        """
+        https://www.investopedia.com/terms/z/zscore.asp.
 
         Returns
         -------
-        float
+        Union[float, Pandas.Series]
             Z-score as (last return - mean return) / standard deviation of returns.
         """
         return self.z_score_func()
 
     @property
     def max_drawdown(self: TypeCommonModel) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/m/maximum-drawdown-mdd.asp
+        """
+        https://www.investopedia.com/terms/m/maximum-drawdown-mdd.asp.
 
         Returns
         -------
@@ -250,6 +270,8 @@ class CommonModel:
     @property
     def worst(self: TypeCommonModel) -> Union[float, Series]:
         """
+        Most negative percentage change.
+
         Returns
         -------
         Union[float, Pandas.Series]
@@ -261,6 +283,8 @@ class CommonModel:
     @property
     def positive_share(self: TypeCommonModel) -> Union[float, Series]:
         """
+        The share of percentage changes that are greater than zero.
+
         Returns
         -------
         Union[float, Pandas.Series]
@@ -270,7 +294,8 @@ class CommonModel:
 
     @property
     def skew(self: TypeCommonModel) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/s/skewness.asp
+        """
+        https://www.investopedia.com/terms/s/skewness.asp.
 
         Returns
         -------
@@ -281,7 +306,8 @@ class CommonModel:
 
     @property
     def kurtosis(self: TypeCommonModel) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/k/kurtosis.asp
+        """
+        https://www.investopedia.com/terms/k/kurtosis.asp.
 
         Returns
         -------
@@ -292,7 +318,8 @@ class CommonModel:
 
     @property
     def cvar_down(self: TypeCommonModel) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/c/conditional_value_at_risk.asp
+        """
+        https://www.investopedia.com/terms/c/conditional_value_at_risk.asp.
 
         Returns
         -------
@@ -304,14 +331,16 @@ class CommonModel:
 
     @property
     def var_down(self: TypeCommonModel) -> Union[float, Series]:
-        """Downside 95% Value At Risk, "VaR". The equivalent of
-        percentile.inc([...], 1-level) over returns in MS Excel \n
-        https://www.investopedia.com/terms/v/var.asp
+        """
+        Downside 95% Value At Risk (VaR).
+
+        The equivalent of percentile.inc([...], 1-level) over returns in MS Excel.
+        https://www.investopedia.com/terms/v/var.asp.
 
         Returns
         -------
         Union[float, Pandas.Series]
-            Downside 95% Value At Risk
+            Downside 95% Value At Risk (VaR)
         """
         level: float = 0.95
         interpolation: LiteralQuantileInterp = "lower"
@@ -320,6 +349,10 @@ class CommonModel:
     @property
     def vol_from_var(self: TypeCommonModel) -> Union[float, Series]:
         """
+        Implied annualized volatility from Downside 95% Value at Risk.
+
+        Assumes that returns are normally distributed.
+
         Returns
         -------
         Union[float, Pandas.Series]
@@ -331,15 +364,16 @@ class CommonModel:
         return self.vol_from_var_func(level=level, interpolation=interpolation)
 
     def value_to_log(self: TypeCommonModel) -> TypeCommonModel:
-        """Converts a valueseries into logarithmic weighted series \n
-        Equivalent to LN(value[t] / value[t=0]) in MS Excel
+        """
+        Series of values converted into logarithmic weighted series.
+
+        Equivalent to LN(value[t] / value[t=0]) in Excel.
 
         Returns
         -------
         self
             An object of the same class
         """
-
         self.tsdf = DataFrame(
             data=log(self.tsdf / self.tsdf.iloc[0]),
             index=self.tsdf.index,
@@ -348,9 +382,11 @@ class CommonModel:
         return self
 
     def value_nan_handle(
-        self: TypeCommonModel, method: LiteralNanMethod = "fill"
+        self: TypeCommonModel,
+        method: LiteralNanMethod = "fill",
     ) -> TypeCommonModel:
-        """Handling of missing values in a valueseries
+        """
+        Handle missing values in a valueseries.
 
         Parameters
         ----------
@@ -363,15 +399,17 @@ class CommonModel:
             An object of the same class
         """
         if method == "fill":
-            self.tsdf.fillna(method="pad", inplace=True)
+            self.tsdf = self.tsdf.fillna(method="pad")
         else:
-            self.tsdf.dropna(inplace=True)
+            self.tsdf = self.tsdf.dropna()
         return self
 
     def return_nan_handle(
-        self: TypeCommonModel, method: LiteralNanMethod = "fill"
+        self: TypeCommonModel,
+        method: LiteralNanMethod = "fill",
     ) -> TypeCommonModel:
-        """Handling of missing values in a returnseries
+        """
+        Handle missing values in a returnseries.
 
         Parameters
         ----------
@@ -384,28 +422,31 @@ class CommonModel:
             An object of the same class
         """
         if method == "fill":
-            self.tsdf.fillna(value=0.0, inplace=True)
+            self.tsdf = self.tsdf.fillna(value=0.0)
         else:
-            self.tsdf.dropna(inplace=True)
+            self.tsdf = self.tsdf.dropna()
         return self
 
     def to_drawdown_series(self: TypeCommonModel) -> TypeCommonModel:
-        """Converts timeseries into a drawdown series
+        """
+        Convert timeseries into a drawdown series.
 
         Returns
         -------
         self
             An object of the same class
         """
-
         for serie in self.tsdf:
             self.tsdf.loc[:, serie] = drawdown_series(self.tsdf.loc[:, serie])
         return self
 
     def to_json(
-        self: TypeCommonModel, filename: str, directory: Optional[str] = None
+        self: TypeCommonModel,
+        filename: str,
+        directory: Optional[str] = None,
     ) -> list[dict[str, Union[str, bool, ValueType, list[str], list[float]]]]:
-        """Dumps timeseries data into a json file
+        """
+        Dump timeseries data into a json file.
 
         The label and tsdf parameters are deleted before the json file is saved
 
@@ -415,6 +456,7 @@ class CommonModel:
             Filename including filetype
         directory: str, optional
             File folder location
+
         Returns
         -------
         list[Dict[str, Union[str, bool, ValueType, list[str], list[float]]]]
@@ -451,7 +493,8 @@ class CommonModel:
         sheet_title: Optional[str] = None,
         directory: Optional[str] = None,
     ) -> str:
-        """Saves the data in the .tsdf DataFrame to an Excel spreadsheet file
+        """
+        Save .tsdf DataFrame to an Excel spreadsheet file.
 
         Parameters
         ----------
@@ -461,12 +504,12 @@ class CommonModel:
             Name of the sheet in the Excel file
         directory: str, optional
             The file directory where the Excel file is saved.
+
         Returns
         -------
         str
             The Excel file path
         """
-
         if filename[-5:].lower() != ".xlsx":
             raise NameError("Filename must end with .xlsx")
         if directory:
@@ -499,7 +542,8 @@ class CommonModel:
         add_logo: bool = True,
         output_type: LiteralPlotlyOutput = "file",
     ) -> tuple[Figure, str]:
-        """Creates a Plotly Bar Figure
+        """
+        Create a Plotly Bar Figure.
 
         Parameters
         ----------
@@ -525,7 +569,7 @@ class CommonModel:
 
         Returns
         -------
-        (plotly.go.Figure, str)
+        tuple[plotly.go.Figure, str]
             Plotly Figure and html filename with location
         """
         if labels:
@@ -584,11 +628,8 @@ class CommonModel:
         show_last: bool = False,
         output_type: LiteralPlotlyOutput = "file",
     ) -> tuple[Figure, str]:
-        """Creates a Plotly Figure
-
-        To scale the bubble size, use the attribute sizeref.
-        We recommend using the following formula to calculate a sizeref value:
-        sizeref = 2. * max(array of size values) / (desired maximum marker size ** 2)
+        """
+        Create a Plotly Scatter Figure.
 
         Parameters
         ----------
@@ -616,10 +657,9 @@ class CommonModel:
 
         Returns
         -------
-        (plotly.go.Figure, str)
+        tuple[plotly.go.Figure, str]
             Plotly Figure and html filename with location
         """
-
         if labels:
             assert (
                 len(labels) == self.tsdf.shape[1]
@@ -686,7 +726,8 @@ class CommonModel:
         to_date: Optional[dt.date] = None,
         periods_in_a_year_fixed: Optional[int] = None,
     ) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/a/arithmeticmean.asp
+        """
+        https://www.investopedia.com/terms/a/arithmeticmean.asp.
 
         Parameters
         ----------
@@ -706,7 +747,6 @@ class CommonModel:
         Union[float, Pandas.Series]
             Annualized arithmetic mean of returns
         """
-
         earlier, later = get_calc_range(
             data=self.tsdf,
             months_offset=months_from_last,
@@ -718,7 +758,8 @@ class CommonModel:
         else:
             fraction = (later - earlier).days / 365.25
             how_many = self.tsdf.loc[
-                cast(int, earlier) : cast(int, later), self.tsdf.columns.values[0]
+                cast(int, earlier) : cast(int, later),
+                self.tsdf.columns.to_numpy()[0],
             ].count()
             time_factor = how_many / fraction
 
@@ -742,9 +783,11 @@ class CommonModel:
         to_date: Optional[dt.date] = None,
         periods_in_a_year_fixed: Optional[int] = None,
     ) -> Union[float, Series]:
-        """Based on Pandas .std() which is the equivalent of stdev.s([...])
-        in MS Excel \n
-        https://www.investopedia.com/terms/v/volatility.asp
+        """
+        Annualized volatility.
+
+        Based on Pandas .std() which is the equivalent of stdev.s([...]) in MS Excel.
+        https://www.investopedia.com/terms/v/volatility.asp.
 
         Parameters
         ----------
@@ -763,7 +806,6 @@ class CommonModel:
         Union[float, Pandas.Series]
             Annualized volatility
         """
-
         earlier, later = get_calc_range(
             data=self.tsdf,
             months_offset=months_from_last,
@@ -803,9 +845,13 @@ class CommonModel:
         periods_in_a_year_fixed: Optional[int] = None,
     ) -> Union[float, Series]:
         """
+        Implied annualized volatility.
+
+        Implied annualized volatility from the Downside VaR using the assumption
+        that returns are normally distributed.
+
         Parameters
         ----------
-
         level: float, default: 0.95
             The sought VaR level
         months_from_last : int, optional
@@ -853,8 +899,11 @@ class CommonModel:
         drift_adjust: bool = False,
         periods_in_a_year_fixed: Optional[int] = None,
     ) -> Union[float, Series]:
-        """A position weight multiplier from the ratio between a VaR implied
-        volatility and a given target volatility. Multiplier = 1.0 -> target met
+        """
+        Target weight from VaR.
+
+        A position weight multiplier from the ratio between a VaR implied
+        volatility and a given target volatility. Multiplier = 1.0 -> target met.
 
         Parameters
         ----------
@@ -908,7 +957,10 @@ class CommonModel:
         from_date: Optional[dt.date] = None,
         to_date: Optional[dt.date] = None,
     ) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/c/conditional_value_at_risk.asp
+        """
+        Downside Conditional Value At Risk "CVaR".
+
+        https://www.investopedia.com/terms/c/conditional_value_at_risk.asp.
 
         Parameters
         ----------
@@ -927,7 +979,6 @@ class CommonModel:
         Union[float, Pandas.Series]
             Downside Conditional Value At Risk "CVaR"
         """
-
         earlier, later = get_calc_range(
             data=self.tsdf,
             months_offset=months_from_last,
@@ -960,10 +1011,12 @@ class CommonModel:
         to_date: Optional[dt.date] = None,
         periods_in_a_year_fixed: Optional[int] = None,
     ) -> Union[float, Series]:
-        """The standard deviation of returns that are below a Minimum Accepted
-        Return of zero.
-        It is used to calculate the Sortino Ratio \n
-        https://www.investopedia.com/terms/d/downside-deviation.asp
+        """
+        Downside Deviation.
+
+        The standard deviation of returns that are below a Minimum Accepted
+        Return of zero. It is used to calculate the Sortino Ratio.
+        https://www.investopedia.com/terms/d/downside-deviation.asp.
 
         Parameters
         ----------
@@ -985,7 +1038,6 @@ class CommonModel:
         Union[float, Pandas.Series]
             Downside deviation
         """
-
         earlier, later = get_calc_range(
             data=self.tsdf,
             months_offset=months_from_last,
@@ -1026,7 +1078,10 @@ class CommonModel:
         from_date: Optional[dt.date] = None,
         to_date: Optional[dt.date] = None,
     ) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/c/cagr.asp
+        """
+        Compounded Annual Growth Rate (CAGR).
+
+        https://www.investopedia.com/terms/c/cagr.asp.
 
         Parameters
         ----------
@@ -1057,7 +1112,7 @@ class CommonModel:
         ):
             raise ValueError(
                 "Geometric return cannot be calculated due to an initial "
-                "value being zero or a negative value."
+                "value being zero or a negative value.",
             )
 
         result = (self.tsdf.iloc[-1] / self.tsdf.iloc[0]) ** (1 / fraction) - 1
@@ -1071,13 +1126,65 @@ class CommonModel:
             dtype="float64",
         )
 
+    def skew_func(
+        self: TypeCommonModel,
+        months_from_last: Optional[int] = None,
+        from_date: Optional[dt.date] = None,
+        to_date: Optional[dt.date] = None,
+    ) -> Union[float, Series]:
+        """
+        Skew of the return distribution.
+
+        https://www.investopedia.com/terms/s/skewness.asp.
+
+        Parameters
+        ----------
+        months_from_last : int, optional
+            number of months offset as positive integer. Overrides use of from_date
+            and to_date
+        from_date : datetime.date, optional
+            Specific from date
+        to_date : datetime.date, optional
+            Specific to date
+
+        Returns
+        -------
+        Union[float, Pandas.Series]
+            Skew of the return distribution
+        """
+        earlier, later = get_calc_range(
+            data=self.tsdf,
+            months_offset=months_from_last,
+            from_dt=from_date,
+            to_dt=to_date,
+        )
+        result = skew(
+            a=self.tsdf.loc[cast(int, earlier) : cast(int, later)]
+            .pct_change()
+            .to_numpy(),
+            bias=True,
+            nan_policy="omit",
+        )
+
+        if self.tsdf.shape[1] == 1:
+            return float(result[0])
+        return Series(
+            data=result,
+            index=self.tsdf.columns,
+            name="Skew",
+            dtype="float64",
+        )
+
     def kurtosis_func(
         self: TypeCommonModel,
         months_from_last: Optional[int] = None,
         from_date: Optional[dt.date] = None,
         to_date: Optional[dt.date] = None,
     ) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/k/kurtosis.asp
+        """
+        Kurtosis of the return distribution.
+
+        https://www.investopedia.com/terms/k/kurtosis.asp.
 
         Parameters
         ----------
@@ -1094,7 +1201,6 @@ class CommonModel:
         Union[float, Pandas.Series]
             Kurtosis of the return distribution
         """
-
         earlier, later = get_calc_range(
             data=self.tsdf,
             months_offset=months_from_last,
@@ -1124,7 +1230,10 @@ class CommonModel:
         to_date: Optional[dt.date] = None,
         min_periods: int = 1,
     ) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/m/maximum-drawdown-mdd.asp
+        """
+        Maximum drawdown without any limit on date range.
+
+        https://www.investopedia.com/terms/m/maximum-drawdown-mdd.asp.
 
         Parameters
         ----------
@@ -1166,14 +1275,16 @@ class CommonModel:
 
     @property
     def max_drawdown_date(self: TypeCommonModel) -> Union[dt.date, Series]:
-        """https://www.investopedia.com/terms/m/maximum-drawdown-mdd.asp
+        """
+        Date when the maximum drawdown occurred.
+
+        https://www.investopedia.com/terms/m/maximum-drawdown-mdd.asp.
 
         Returns
         -------
         Union[datetime.date, pandas.Series]
             Date when the maximum drawdown occurred
         """
-
         mdddf = self.tsdf.copy()
         mdddf.index = DatetimeIndex(mdddf.index)
         result = (mdddf / mdddf.expanding(min_periods=1).max()).idxmin().dt.date
@@ -1184,8 +1295,8 @@ class CommonModel:
             data=result,
             index=self.tsdf.columns,
             name="Max drawdown date",
-            dtype="float64",
-        )
+            dtype="datetime64[ns]",
+        ).dt.date
 
     def positive_share_func(
         self: TypeCommonModel,
@@ -1193,7 +1304,8 @@ class CommonModel:
         from_date: Optional[dt.date] = None,
         to_date: Optional[dt.date] = None,
     ) -> Union[float, Series]:
-        """The share of percentage changes that are greater than zero
+        """
+        Calculate share of percentage changes that are greater than zero.
 
         Parameters
         ----------
@@ -1208,7 +1320,7 @@ class CommonModel:
         Returns
         -------
         Union[float, Pandas.Series]
-            The share of percentage changes that are greater than zero
+            Calculate share of percentage changes that are greater than zero
         """
         earlier, later = get_calc_range(
             data=self.tsdf,
@@ -1244,11 +1356,14 @@ class CommonModel:
         to_date: Optional[dt.date] = None,
         periods_in_a_year_fixed: Optional[int] = None,
     ) -> Union[float, Series]:
-        """The ratio of annualized arithmetic mean of returns and annualized
+        """
+        Ratio between arithmetic mean of returns and annualized volatility.
+
+        The ratio of annualized arithmetic mean of returns and annualized
         volatility or, if riskfree return provided, Sharpe ratio calculated
         as ( geometric return - risk-free return ) / volatility. The latter ratio
-        implies that the riskfree asset has zero volatility. \n
-        https://www.investopedia.com/terms/s/sharperatio.asp
+        implies that the riskfree asset has zero volatility.
+        https://www.investopedia.com/terms/s/sharperatio.asp.
 
         Parameters
         ----------
@@ -1269,8 +1384,7 @@ class CommonModel:
         -------
         Union[float, Pandas.Series]
             Ratio of the annualized arithmetic mean of returns and annualized
-            volatility or,
-            if risk-free return provided, Sharpe ratio
+            volatility or, if risk-free return provided, Sharpe ratio
         """
         ratio: Series = (
             self.arithmetic_ret_func(
@@ -1293,50 +1407,6 @@ class CommonModel:
         ratio = ratio.astype("float64")
         return ratio
 
-    def skew_func(
-        self: TypeCommonModel,
-        months_from_last: Optional[int] = None,
-        from_date: Optional[dt.date] = None,
-        to_date: Optional[dt.date] = None,
-    ) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/s/skewness.asp
-
-        Parameters
-        ----------
-        months_from_last : int, optional
-            number of months offset as positive integer. Overrides use of from_date
-            and to_date
-        from_date : datetime.date, optional
-            Specific from date
-        to_date : datetime.date, optional
-            Specific to date
-
-        Returns
-        -------
-        Union[float, Pandas.Series]
-            Skew of the return distribution
-        """
-        earlier, later = get_calc_range(
-            data=self.tsdf,
-            months_offset=months_from_last,
-            from_dt=from_date,
-            to_dt=to_date,
-        )
-        result = skew(
-            a=self.tsdf.loc[cast(int, earlier) : cast(int, later)].pct_change().values,
-            bias=True,
-            nan_policy="omit",
-        )
-
-        if self.tsdf.shape[1] == 1:
-            return float(result[0])
-        return Series(
-            data=result,
-            index=self.tsdf.columns,
-            name="Skew",
-            dtype="float64",
-        )
-
     def sortino_ratio_func(
         self: TypeCommonModel,
         riskfree_rate: float = 0.0,
@@ -1346,11 +1416,14 @@ class CommonModel:
         to_date: Optional[dt.date] = None,
         periods_in_a_year_fixed: Optional[int] = None,
     ) -> Union[float, Series]:
-        """The Sortino ratio calculated as ( return - risk free return )
+        """
+        Sortino Ratio.
+
+        The Sortino ratio calculated as ( return - risk free return )
         / downside deviation. The ratio implies that the riskfree asset has zero
         volatility, and a minimum acceptable return of zero. The ratio is
-        calculated using the annualized arithmetic mean of returns. \n
-        https://www.investopedia.com/terms/s/sortinoratio.asp
+        calculated using the annualized arithmetic mean of returns.
+        https://www.investopedia.com/terms/s/sortinoratio.asp.
 
         Parameters
         ----------
@@ -1404,6 +1477,8 @@ class CommonModel:
         to_date: Optional[dt.date] = None,
     ) -> Union[float, Series]:
         """
+        Calculate simple return.
+
         Parameters
         ----------
         months_from_last : int, optional
@@ -1417,9 +1492,8 @@ class CommonModel:
         Returns
         -------
         Union[float, Pandas.Series]
-            Simple return
+            Calculate simple return
         """
-
         earlier, later = get_calc_range(
             data=self.tsdf,
             months_offset=months_from_last,
@@ -1429,7 +1503,7 @@ class CommonModel:
         if 0.0 in self.tsdf.iloc[0].tolist():
             raise ValueError(
                 f"Simple return cannot be calculated due to an "
-                f"initial value being zero. ({self.tsdf.head(3)})"
+                f"initial value being zero. ({self.tsdf.head(3)})",
             )
 
         result = self.tsdf.loc[later] / self.tsdf.loc[earlier] - 1
@@ -1444,9 +1518,13 @@ class CommonModel:
         )
 
     def value_ret_calendar_period(
-        self: TypeCommonModel, year: int, month: Optional[int] = None
+        self: TypeCommonModel,
+        year: int,
+        month: Optional[int] = None,
     ) -> Union[float, Series]:
         """
+        Calculate simple return for a specific calendar period.
+
         Parameters
         ----------
         year : int
@@ -1457,9 +1535,8 @@ class CommonModel:
         Returns
         -------
         Union[float, Pandas.Series]
-            Simple return for a specific calendar period
+            Calculate simple return for a specific calendar period
         """
-
         if month is None:
             period = str(year)
         else:
@@ -1483,9 +1560,11 @@ class CommonModel:
         to_date: Optional[dt.date] = None,
         interpolation: LiteralQuantileInterp = "lower",
     ) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/v/var.asp
-        Downside Value At Risk, "VaR". The equivalent of
-        percentile.inc([...], 1-level) over returns in MS Excel.
+        """
+        Downside Value At Risk, "VaR".
+
+        The equivalent of percentile.inc([...], 1-level) over returns in MS Excel.
+        https://www.investopedia.com/terms/v/var.asp.
 
         Parameters
         ----------
@@ -1534,8 +1613,8 @@ class CommonModel:
         from_date: Optional[dt.date] = None,
         to_date: Optional[dt.date] = None,
     ) -> Union[float, Series]:
-        """Most negative percentage change over a rolling number of observations
-        within a chosen date range
+        """
+        Most negative percentage change over a rolling number of observations.
 
         Parameters
         ----------
@@ -1584,7 +1663,10 @@ class CommonModel:
         from_date: Optional[dt.date] = None,
         to_date: Optional[dt.date] = None,
     ) -> Union[float, Series]:
-        """https://www.investopedia.com/terms/z/zscore.asp
+        """
+        Z-score as (last return - mean return) / standard deviation of returns.
+
+        https://www.investopedia.com/terms/z/zscore.asp.
 
         Parameters
         ----------
@@ -1601,7 +1683,6 @@ class CommonModel:
         Union[float, Pandas.Series]
             Z-score as (last return - mean return) / standard deviation of returns
         """
-
         earlier, later = get_calc_range(
             data=self.tsdf,
             months_offset=months_from_last,
@@ -1627,6 +1708,8 @@ class CommonModel:
         observations: int = 252,
     ) -> DataFrame:
         """
+        Calculate rolling annualized downside CVaR.
+
         Parameters
         ----------
         column: int, default: 0
@@ -1639,7 +1722,7 @@ class CommonModel:
         Returns
         -------
         Pandas.DataFrame
-            Rolling annualized downside CVaR
+            Calculate rolling annualized downside CVaR
         """
         cvar_label = self.tsdf.iloc[:, column].name[0]
         cvardf = (
@@ -1653,9 +1736,13 @@ class CommonModel:
         return cvardf
 
     def rolling_return(
-        self: TypeCommonModel, column: int = 0, observations: int = 21
+        self: TypeCommonModel,
+        column: int = 0,
+        observations: int = 21,
     ) -> DataFrame:
         """
+        Calculate rolling returns.
+
         Parameters
         ----------
         column: int, default: 0
@@ -1666,7 +1753,7 @@ class CommonModel:
         Returns
         -------
         Pandas.DataFrame
-            Rolling returns
+            Calculate rolling returns
         """
         ret_label = self.tsdf.iloc[:, column].name[0]
         retdf = (
@@ -1688,6 +1775,8 @@ class CommonModel:
         interpolation: LiteralQuantileInterp = "lower",
     ) -> DataFrame:
         """
+        Calculate rolling annualized downside Value At Risk "VaR".
+
         Parameters
         ----------
         column: int, default: 0
@@ -1702,14 +1791,14 @@ class CommonModel:
         Returns
         -------
         Pandas.DataFrame
-           Rolling annualized downside Value At Risk "VaR"
+           Calculate rolling annualized downside Value At Risk "VaR"
         """
         var_label = self.tsdf.iloc[:, column].name[0]
         vardf = (
             self.tsdf.iloc[:, column]
             .rolling(observations, min_periods=observations)
             .apply(
-                lambda x: var_down_calc(x, level=level, interpolation=interpolation)
+                lambda x: var_down_calc(x, level=level, interpolation=interpolation),
             )
         )
         vardf = vardf.dropna().to_frame()
@@ -1724,6 +1813,8 @@ class CommonModel:
         periods_in_a_year_fixed: Optional[int] = None,
     ) -> DataFrame:
         """
+        Calculate rolling annualised volatilities.
+
         Parameters
         ----------
         column: int, default: 0
@@ -1737,7 +1828,7 @@ class CommonModel:
         Returns
         -------
         Pandas.DataFrame
-            Rolling annualised volatilities
+            Calculate rolling annualised volatilities
         """
         if periods_in_a_year_fixed:
             time_factor = float(periods_in_a_year_fixed)
@@ -1746,7 +1837,7 @@ class CommonModel:
         vol_label = self.tsdf.iloc[:, column].name[0]
         dframe = self.tsdf.iloc[:, column].pct_change()
         voldf = dframe.rolling(observations, min_periods=observations).std() * sqrt(
-            time_factor
+            time_factor,
         )
         voldf = voldf.dropna().to_frame()
         voldf.columns = [[vol_label], ["Rolling volatility"]]
@@ -1767,10 +1858,13 @@ def _var_implied_vol_and_target_func(
     drift_adjust: bool = False,
     periods_in_a_year_fixed: Optional[int] = None,
 ) -> Union[float, Series]:
-    """The function returns a position weight multiplier from the ratio between
+    """
+    Volatility implied from VaR or Target Weight.
+
+    The function returns a position weight multiplier from the ratio between
     a VaR implied volatility and a given target volatility if the argument
     target_vol is provided. Otherwise the function returns the VaR implied
-    volatility. Multiplier = 1.0 -> target met
+    volatility. Multiplier = 1.0 -> target met.
 
     Parameters
     ----------
@@ -1836,7 +1930,7 @@ def _var_implied_vol_and_target_func(
 
     if target_vol:
         result = imp_vol.apply(
-            lambda x: max(min_leverage_local, min(target_vol / x, max_leverage_local))
+            lambda x: max(min_leverage_local, min(target_vol / x, max_leverage_local)),
         )
         label = "Weight from target vol"
     else: