mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 13:32:08 +00:00
5aebae4d46
* Get rid of required ticker and add -t argument to all of fa * ta to work without ticker * Allow bt to be accessed without ticker * Bt not ticker dependent (last commit was qa) * Update stock controller * UPdate tests * Review changes + update tests
1160 lines
37 KiB
Python
1160 lines
37 KiB
Python
"""Quantitative Analysis Controller Module"""
|
||
__docformat__ = "numpy"
|
||
|
||
import argparse
|
||
import logging
|
||
from datetime import datetime
|
||
from typing import List
|
||
|
||
import pandas as pd
|
||
|
||
from openbb_terminal import feature_flags as obbff
|
||
from openbb_terminal.common.quantitative_analysis import qa_view, rolling_view
|
||
from openbb_terminal.custom_prompt_toolkit import NestedCompleter
|
||
from openbb_terminal.decorators import log_start_end
|
||
from openbb_terminal.helper_funcs import (
|
||
EXPORT_ONLY_FIGURES_ALLOWED,
|
||
EXPORT_ONLY_RAW_DATA_ALLOWED,
|
||
check_list_dates,
|
||
check_positive,
|
||
check_proportion_range,
|
||
)
|
||
from openbb_terminal.menu import session
|
||
from openbb_terminal.parent_classes import StockBaseController
|
||
from openbb_terminal.rich_config import MenuText, console
|
||
from openbb_terminal.stocks import stocks_helper
|
||
from openbb_terminal.stocks.quantitative_analysis.beta_view import beta_view
|
||
from openbb_terminal.stocks.quantitative_analysis.factors_view import capm_view
|
||
from openbb_terminal.stocks.quantitative_analysis.qa_model import full_stock_df
|
||
|
||
# pylint: disable=C0302
|
||
|
||
logger = logging.getLogger(__name__)
|
||
|
||
|
||
def no_data_message():
|
||
"""Print message when no ticker is loaded"""
|
||
console.print("[red]No data loaded. Use 'load' command to load a symbol[/red]")
|
||
|
||
|
||
class QaController(StockBaseController):
|
||
"""Quantitative Analysis Controller class"""
|
||
|
||
CHOICES_COMMANDS = [
|
||
"load",
|
||
"pick",
|
||
"raw",
|
||
"summary",
|
||
"line",
|
||
"hist",
|
||
"cdf",
|
||
"bw",
|
||
"rolling",
|
||
"decompose",
|
||
"cusum",
|
||
"acf",
|
||
"spread",
|
||
"quantile",
|
||
"skew",
|
||
"kurtosis",
|
||
"normality",
|
||
"qqplot",
|
||
"unitroot",
|
||
"capm",
|
||
"beta",
|
||
"var",
|
||
"es",
|
||
"sh",
|
||
"so",
|
||
"om",
|
||
]
|
||
|
||
stock_interval = [1, 5, 15, 30, 60]
|
||
stock_sources = ["YahooFinance", "AlphaVantage"]
|
||
distributions = ["laplace", "student_t", "logistic", "normal"]
|
||
FULLER_REG = ["c", "ct", "ctt", "nc"]
|
||
KPS_REG = ["c", "ct"]
|
||
VALID_DISTRIBUTIONS = ["laplace", "student_t", "logistic", "normal"]
|
||
PATH = "/stocks/qa/"
|
||
CHOICES_GENERATION = True
|
||
|
||
def __init__(
|
||
self,
|
||
ticker: str,
|
||
start: datetime,
|
||
interval: str,
|
||
stock: pd.DataFrame,
|
||
queue: List[str] = None,
|
||
):
|
||
"""Constructor"""
|
||
super().__init__(queue)
|
||
if not stock.empty:
|
||
self.stock = full_stock_df(stock)
|
||
else:
|
||
self.stock = stock
|
||
self.ticker = ticker
|
||
self.start = start
|
||
self.interval = interval
|
||
self.target = "returns" if not stock.empty else ""
|
||
|
||
if session and obbff.USE_PROMPT_TOOLKIT:
|
||
choices: dict = self.choices_default
|
||
|
||
self.completer = NestedCompleter.from_nested_dict(choices)
|
||
|
||
def print_help(self):
|
||
"""Print help"""
|
||
s_intraday = (f"Intraday {self.interval}", "Daily")[self.interval == "1440min"]
|
||
if self.start:
|
||
stock_str = (
|
||
f"{s_intraday} {self.ticker} (from {self.start.strftime('%Y-%m-%d')})"
|
||
)
|
||
else:
|
||
stock_str = f"{s_intraday} {self.ticker}"
|
||
|
||
mt = MenuText("stocks/qa/")
|
||
mt.add_cmd("load")
|
||
mt.add_cmd("pick")
|
||
mt.add_raw("\n")
|
||
mt.add_param("_ticker", stock_str)
|
||
mt.add_param("_target", self.target)
|
||
mt.add_raw("\n")
|
||
mt.add_info("_statistics_")
|
||
mt.add_cmd("summary")
|
||
mt.add_cmd("normality")
|
||
mt.add_cmd("unitroot")
|
||
mt.add_info("_plots_")
|
||
mt.add_cmd("line")
|
||
mt.add_cmd("hist")
|
||
mt.add_cmd("cdf")
|
||
mt.add_cmd("bw")
|
||
mt.add_cmd("acf")
|
||
mt.add_cmd("qqplot")
|
||
mt.add_info("_rolling_metrics_")
|
||
mt.add_cmd("rolling")
|
||
mt.add_cmd("spread")
|
||
mt.add_cmd("quantile")
|
||
mt.add_cmd("skew")
|
||
mt.add_cmd("kurtosis")
|
||
mt.add_info("_risk_")
|
||
mt.add_cmd("var")
|
||
mt.add_cmd("es")
|
||
mt.add_cmd("sh")
|
||
mt.add_cmd("so")
|
||
mt.add_cmd("om")
|
||
mt.add_info("_other_")
|
||
mt.add_cmd("raw")
|
||
mt.add_cmd("decompose")
|
||
mt.add_cmd("cusum")
|
||
mt.add_cmd("capm")
|
||
mt.add_cmd("beta")
|
||
console.print(text=mt.menu_text, menu="Stocks - Quantitative Analysis")
|
||
|
||
def custom_reset(self):
|
||
"""Class specific component of reset command"""
|
||
if self.ticker:
|
||
if self.target:
|
||
return ["stocks", f"load {self.ticker}", "qa", f"pick {self.target}"]
|
||
return ["stocks", f"load {self.ticker}", "qa"]
|
||
return []
|
||
|
||
@log_start_end(log=logger)
|
||
def call_pick(self, other_args: List[str]):
|
||
"""Process pick command"""
|
||
parser = argparse.ArgumentParser(
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
add_help=False,
|
||
prog="pick",
|
||
description="""
|
||
Change target variable
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-t",
|
||
"--target",
|
||
dest="target",
|
||
type=str.lower,
|
||
choices=list(self.stock.columns),
|
||
help="Select variable to analyze",
|
||
)
|
||
if other_args and "-" not in other_args[0][0]:
|
||
other_args.insert(0, "-t")
|
||
|
||
ns_parser = self.parse_known_args_and_warn(parser, other_args)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
self.target = ns_parser.target
|
||
|
||
@log_start_end(log=logger)
|
||
def call_raw(self, other_args: List[str]):
|
||
parser = argparse.ArgumentParser(
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
add_help=False,
|
||
prog="raw",
|
||
description="""
|
||
Print raw data to console
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-l",
|
||
"--limit",
|
||
help="Number to show",
|
||
type=check_positive,
|
||
default=20,
|
||
dest="limit",
|
||
)
|
||
parser.add_argument(
|
||
"-r",
|
||
"--reverse",
|
||
action="store_true",
|
||
dest="reverse",
|
||
default=False,
|
||
help=(
|
||
"Data is sorted in descending order by default. "
|
||
"Reverse flag will sort it in an ascending way. "
|
||
"Only works when raw data is displayed."
|
||
),
|
||
)
|
||
parser.add_argument(
|
||
"-s",
|
||
"--sortby",
|
||
help="The column to sort by",
|
||
choices=stocks_helper.format_parse_choices(self.stock.columns),
|
||
type=str.lower,
|
||
dest="sortby",
|
||
)
|
||
|
||
ns_parser = self.parse_known_args_and_warn(
|
||
parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED
|
||
)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
qa_view.display_raw(
|
||
data=self.stock,
|
||
limit=ns_parser.limit,
|
||
sortby=ns_parser.sortby,
|
||
ascend=ns_parser.reverse,
|
||
export=ns_parser.export,
|
||
sheet_name=" ".join(ns_parser.sheet_name)
|
||
if ns_parser.sheet_name
|
||
else None,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_summary(self, other_args: List[str]):
|
||
"""Process summary command"""
|
||
parser = argparse.ArgumentParser(
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
add_help=False,
|
||
prog="summary",
|
||
description="""
|
||
Summary statistics
|
||
""",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(
|
||
parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED
|
||
)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
qa_view.display_summary(
|
||
data=self.stock,
|
||
export=ns_parser.export,
|
||
sheet_name=" ".join(ns_parser.sheet_name)
|
||
if ns_parser.sheet_name
|
||
else None,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_line(self, other_args: List[str]):
|
||
"""Process line command"""
|
||
parser = argparse.ArgumentParser(
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
add_help=False,
|
||
prog="line",
|
||
description="Show line plot of selected data or highlight specific datetimes.",
|
||
)
|
||
parser.add_argument(
|
||
"--log",
|
||
help="Plot with y on log scale",
|
||
dest="log",
|
||
action="store_true",
|
||
default=False,
|
||
)
|
||
parser.add_argument(
|
||
"--ml",
|
||
help="Draw vertical line markers to highlight certain events",
|
||
dest="ml",
|
||
type=check_list_dates,
|
||
default="",
|
||
)
|
||
parser.add_argument(
|
||
"--ms",
|
||
help="Draw scatter markers to highlight certain events",
|
||
dest="ms",
|
||
type=check_list_dates,
|
||
default="",
|
||
)
|
||
|
||
ns_parser = self.parse_known_args_and_warn(
|
||
parser, other_args, export_allowed=EXPORT_ONLY_FIGURES_ALLOWED
|
||
)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
qa_view.display_line(
|
||
self.stock[self.target],
|
||
title=f"{self.ticker} {self.target}",
|
||
log_y=ns_parser.log,
|
||
markers_lines=ns_parser.ml,
|
||
markers_scatter=ns_parser.ms,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_hist(self, other_args: List[str]):
|
||
"""Process hist command"""
|
||
parser = argparse.ArgumentParser(
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
add_help=False,
|
||
prog="hist",
|
||
description="""
|
||
Histogram with density and rug
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-b", "--bins", type=check_positive, default=15, dest="n_bins"
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(parser, other_args)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
qa_view.display_hist(
|
||
symbol=self.ticker,
|
||
data=self.stock,
|
||
target=self.target,
|
||
bins=ns_parser.n_bins,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_cdf(self, other_args: List[str]):
|
||
"""Process cdf command"""
|
||
parser = argparse.ArgumentParser(
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
add_help=False,
|
||
prog="cdf",
|
||
description="""
|
||
Cumulative distribution function
|
||
""",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(
|
||
parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED
|
||
)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
qa_view.display_cdf(
|
||
data=self.stock,
|
||
symbol=self.ticker,
|
||
target=self.target,
|
||
export=ns_parser.export,
|
||
sheet_name=" ".join(ns_parser.sheet_name)
|
||
if ns_parser.sheet_name
|
||
else None,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_bw(self, other_args: List[str]):
|
||
"""Process bwy command"""
|
||
parser = argparse.ArgumentParser(
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
add_help=False,
|
||
prog="bw",
|
||
description="""
|
||
Box and Whisker plot
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-y",
|
||
"--yearly",
|
||
action="store_true",
|
||
default=False,
|
||
dest="year",
|
||
help="Flag to show yearly bw plot",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(parser, other_args)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
qa_view.display_bw(
|
||
data=self.stock,
|
||
symbol=self.ticker,
|
||
target=self.target,
|
||
yearly=ns_parser.year,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_decompose(self, other_args: List[str]):
|
||
"""Process decompose command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="decompose",
|
||
description="""
|
||
Decompose time series as:
|
||
- Additive Time Series = Level + CyclicTrend + Residual + Seasonality
|
||
- Multiplicative Time Series = Level * CyclicTrend * Residual * Seasonality
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-m",
|
||
"--multiplicative",
|
||
action="store_true",
|
||
default=False,
|
||
dest="multiplicative",
|
||
help="decompose using multiplicative model instead of additive",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(
|
||
parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED
|
||
)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
qa_view.display_seasonal(
|
||
symbol=self.ticker,
|
||
data=self.stock,
|
||
target=self.target,
|
||
multiplicative=ns_parser.multiplicative,
|
||
export=ns_parser.export,
|
||
sheet_name=" ".join(ns_parser.sheet_name)
|
||
if ns_parser.sheet_name
|
||
else None,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_cusum(self, other_args: List[str]):
|
||
"""Process cusum command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="cusum",
|
||
description="""
|
||
Cumulative sum algorithm (CUSUM) to detect abrupt changes in data
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-t",
|
||
"--threshold",
|
||
dest="threshold",
|
||
type=float,
|
||
default=(
|
||
max(self.stock[self.target].values)
|
||
- min(self.stock[self.target].values)
|
||
)
|
||
/ 40
|
||
if not self.stock.empty
|
||
else 0,
|
||
help="threshold",
|
||
)
|
||
parser.add_argument(
|
||
"-d",
|
||
"--drift",
|
||
dest="drift",
|
||
type=float,
|
||
default=(
|
||
max(self.stock[self.target].values)
|
||
- min(self.stock[self.target].values)
|
||
)
|
||
/ 80
|
||
if not self.stock.empty
|
||
else 0,
|
||
help="drift",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(parser, other_args)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
qa_view.display_cusum(
|
||
data=self.stock,
|
||
target=self.target,
|
||
threshold=ns_parser.threshold,
|
||
drift=ns_parser.drift,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_acf(self, other_args: List[str]):
|
||
"""Process acf command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="acf",
|
||
description="""
|
||
Auto-Correlation and Partial Auto-Correlation Functions for diff and diff diff stock data
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-l",
|
||
"--lags",
|
||
dest="lags",
|
||
type=check_positive,
|
||
default=15,
|
||
help="maximum lags to display in plots",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(parser, other_args)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
if self.target != "adjclose":
|
||
console.print(
|
||
"Target not adjclose. For best results, use `pick adjclose` first."
|
||
)
|
||
|
||
qa_view.display_acf(
|
||
data=self.stock,
|
||
symbol=self.ticker,
|
||
target=self.target,
|
||
lags=ns_parser.lags,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_rolling(self, other_args: List[str]):
|
||
"""Process rolling command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="rolling",
|
||
description="""
|
||
Rolling mean and std deviation
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-w",
|
||
"--window",
|
||
action="store",
|
||
dest="n_window",
|
||
type=check_positive,
|
||
default=14,
|
||
help="Window length",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(
|
||
parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED
|
||
)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
rolling_view.display_mean_std(
|
||
symbol=self.ticker,
|
||
data=self.stock,
|
||
target=self.target,
|
||
window=ns_parser.n_window,
|
||
export=ns_parser.export,
|
||
sheet_name=" ".join(ns_parser.sheet_name)
|
||
if ns_parser.sheet_name
|
||
else None,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_spread(self, other_args: List[str]):
|
||
"""Process spread command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="spread",
|
||
description="""Shows rolling spread measurement
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-w",
|
||
"--window",
|
||
action="store",
|
||
dest="n_window",
|
||
type=check_positive,
|
||
default=14,
|
||
help="Window length",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(
|
||
parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED
|
||
)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
rolling_view.display_spread(
|
||
data=self.stock,
|
||
symbol=self.ticker,
|
||
target=self.target,
|
||
window=ns_parser.n_window,
|
||
export=ns_parser.export,
|
||
sheet_name=" ".join(ns_parser.sheet_name)
|
||
if ns_parser.sheet_name
|
||
else None,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_quantile(self, other_args: List[str]):
|
||
"""Process quantile command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="quantile",
|
||
description="""
|
||
The quantiles are values which divide the distribution such that
|
||
there is a given proportion of observations below the quantile.
|
||
For example, the median is a quantile. The median is the central
|
||
value of the distribution, such that half the points are less than
|
||
or equal to it and half are greater than or equal to it.
|
||
|
||
By default, q is set at 0.5, which effectively is median. Change q to
|
||
get the desired quantile (0<q<1).
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-w",
|
||
"--window",
|
||
action="store",
|
||
dest="n_window",
|
||
type=check_positive,
|
||
default=14,
|
||
help="window length",
|
||
)
|
||
parser.add_argument(
|
||
"-q",
|
||
"--quantile",
|
||
action="store",
|
||
dest="f_quantile",
|
||
type=check_proportion_range,
|
||
default=0.5,
|
||
help="quantile",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(
|
||
parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED
|
||
)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
rolling_view.display_quantile(
|
||
data=self.stock,
|
||
symbol=self.ticker,
|
||
target=self.target,
|
||
window=ns_parser.n_window,
|
||
quantile=ns_parser.f_quantile,
|
||
export=ns_parser.export,
|
||
sheet_name=" ".join(ns_parser.sheet_name)
|
||
if ns_parser.sheet_name
|
||
else None,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_skew(self, other_args: List[str]):
|
||
"""Process skew command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="skew",
|
||
description="""
|
||
Skewness is a measure of asymmetry or distortion of symmetric
|
||
distribution. It measures the deviation of the given distribution
|
||
of a random variable from a symmetric distribution, such as normal
|
||
distribution. A normal distribution is without any skewness, as it is
|
||
symmetrical on both sides. Hence, a curve is regarded as skewed if
|
||
it is shifted towards the right or the left.
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-w",
|
||
"--window",
|
||
action="store",
|
||
dest="n_window",
|
||
type=check_positive,
|
||
default=14,
|
||
help="window length",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(
|
||
parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED
|
||
)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
rolling_view.display_skew(
|
||
symbol=self.ticker,
|
||
data=self.stock,
|
||
target=self.target,
|
||
window=ns_parser.n_window,
|
||
export=ns_parser.export,
|
||
sheet_name=" ".join(ns_parser.sheet_name)
|
||
if ns_parser.sheet_name
|
||
else None,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_kurtosis(self, other_args: List[str]):
|
||
"""Process kurtosis command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="kurtosis",
|
||
description="""
|
||
Kurtosis is a measure of the "tailedness" of the probability distribution
|
||
of a real-valued random variable. Like skewness, kurtosis describes the shape
|
||
of a probability distribution and there are different ways of quantifying it
|
||
for a theoretical distribution and corresponding ways of estimating it from
|
||
a sample from a population. Different measures of kurtosis may have different
|
||
interpretations.
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-w",
|
||
"--window",
|
||
action="store",
|
||
dest="n_window",
|
||
type=check_positive,
|
||
default=14,
|
||
help="window length",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(
|
||
parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED
|
||
)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
rolling_view.display_kurtosis(
|
||
symbol=self.ticker,
|
||
data=self.stock,
|
||
target=self.target,
|
||
window=ns_parser.n_window,
|
||
export=ns_parser.export,
|
||
sheet_name=" ".join(ns_parser.sheet_name)
|
||
if ns_parser.sheet_name
|
||
else None,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_normality(self, other_args: List[str]):
|
||
"""Process normality command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="normality",
|
||
description="""
|
||
Normality tests
|
||
""",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(
|
||
parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED
|
||
)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
qa_view.display_normality(
|
||
data=self.stock, target=self.target, export=ns_parser.export
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_qqplot(self, other_args: List[str]):
|
||
"""Process qqplot command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="qqplot",
|
||
description="""
|
||
Display QQ plot vs normal quantiles
|
||
""",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(parser, other_args)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
qa_view.display_qqplot(
|
||
symbol=self.ticker, data=self.stock, target=self.target
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_unitroot(self, other_args: List[str]):
|
||
"""Process unitroot command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="unitroot",
|
||
description="""
|
||
Unit root test / stationarity (ADF, KPSS)
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-r",
|
||
"--fuller_reg",
|
||
help="Type of regression. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order",
|
||
choices=self.FULLER_REG,
|
||
default="c",
|
||
type=str,
|
||
dest="fuller_reg",
|
||
)
|
||
parser.add_argument(
|
||
"-k",
|
||
"--kps_reg",
|
||
help="Type of regression. Can be ‘c’,’ct'",
|
||
choices=self.KPS_REG,
|
||
type=str,
|
||
dest="kpss_reg",
|
||
default="c",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(
|
||
parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED
|
||
)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
qa_view.display_unitroot(
|
||
data=self.stock,
|
||
target=self.target,
|
||
fuller_reg=ns_parser.fuller_reg,
|
||
kpss_reg=ns_parser.kpss_reg,
|
||
export=ns_parser.export,
|
||
sheet_name=" ".join(ns_parser.sheet_name)
|
||
if ns_parser.sheet_name
|
||
else None,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_capm(self, other_args: List[str]):
|
||
"""Process capm command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="capm",
|
||
description="""
|
||
Provides detailed information about a stock's risk compared to the market risk.
|
||
""",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(parser, other_args)
|
||
if ns_parser:
|
||
if not self.ticker:
|
||
no_data_message()
|
||
return
|
||
capm_view(self.ticker)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_beta(self, other_args: List[str]):
|
||
"""Call the beta command on loaded ticker"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="beta",
|
||
description="""
|
||
Displays a scatter plot demonstrating the beta of two stocks or ETFs.
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-r",
|
||
"--ref",
|
||
action="store",
|
||
dest="ref",
|
||
type=str,
|
||
default="SPY",
|
||
help="""
|
||
Reference ticker used for beta calculation.
|
||
""",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(
|
||
parser, other_args, EXPORT_ONLY_RAW_DATA_ALLOWED
|
||
)
|
||
# This assumes all intervals convert from string to int well
|
||
# This should handle weekly and monthly because the merge would only
|
||
# Work on the intersections
|
||
interval = "".join(c for c in self.interval if c.isdigit())
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
beta_view(
|
||
symbol=self.ticker,
|
||
ref_symbol=ns_parser.ref,
|
||
data=self.stock,
|
||
interval=interval,
|
||
export=ns_parser.export,
|
||
sheet_name=" ".join(ns_parser.sheet_name)
|
||
if ns_parser.sheet_name
|
||
else None,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_var(self, other_args: List[str]):
|
||
"""Process var command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="var",
|
||
description="""
|
||
Provides value at risk (short: VaR) of the selected stock.
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-m",
|
||
"--mean",
|
||
action="store_true",
|
||
default=False,
|
||
dest="use_mean",
|
||
help="If one should use the mean of the stocks return",
|
||
)
|
||
parser.add_argument(
|
||
"-a",
|
||
"--adjusted",
|
||
action="store_true",
|
||
default=False,
|
||
dest="adjusted",
|
||
help="""
|
||
If the VaR should be adjusted for skew and kurtosis (Cornish-Fisher-Expansion)
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-s",
|
||
"--student",
|
||
action="store_true",
|
||
default=False,
|
||
dest="student_t",
|
||
help="""
|
||
If one should use the student-t distribution
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-p",
|
||
"--percentile",
|
||
action="store",
|
||
dest="percentile",
|
||
type=float,
|
||
default=99.9,
|
||
help="""
|
||
Percentile used for VaR calculations, for example input 99.9 equals a 99.9 Percent VaR
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-d",
|
||
"--datarange",
|
||
action="store",
|
||
dest="data_range",
|
||
type=int,
|
||
default=0,
|
||
help="""
|
||
Number of rows you want to use VaR over,
|
||
ex: if you are using days, 30 would show VaR for the last 30 TRADING days
|
||
""",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(parser, other_args)
|
||
if ns_parser:
|
||
if ns_parser.adjusted and ns_parser.student_t:
|
||
console.print("Select the adjusted or the student_t parameter.\n")
|
||
else:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
qa_view.display_var(
|
||
self.stock,
|
||
self.ticker,
|
||
ns_parser.use_mean,
|
||
ns_parser.adjusted,
|
||
ns_parser.student_t,
|
||
ns_parser.percentile,
|
||
ns_parser.data_range,
|
||
False,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_es(self, other_args: List[str]):
|
||
"""Process es command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="es",
|
||
description="Provides Expected Shortfall (short: ES) of the selected stock.",
|
||
)
|
||
parser.add_argument(
|
||
"-m",
|
||
"--mean",
|
||
action="store_true",
|
||
default=False,
|
||
dest="use_mean",
|
||
help="If one should use the mean of the stocks return",
|
||
)
|
||
parser.add_argument(
|
||
"-d",
|
||
"--dist",
|
||
dest="distributions",
|
||
type=str.lower,
|
||
choices=self.distributions,
|
||
default="normal",
|
||
help="Distribution used for the calculations",
|
||
)
|
||
parser.add_argument(
|
||
"-p",
|
||
"--percentile",
|
||
action="store",
|
||
dest="percentile",
|
||
type=float,
|
||
default=99.9,
|
||
help="""
|
||
Percentile for calculations, i.e. input 99.9 equals a 99.9 Percent Expected Shortfall
|
||
""",
|
||
)
|
||
|
||
ns_parser = self.parse_known_args_and_warn(parser, other_args)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
qa_view.display_es(
|
||
self.stock,
|
||
self.ticker,
|
||
ns_parser.use_mean,
|
||
ns_parser.distributions,
|
||
ns_parser.percentile,
|
||
False,
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_sh(self, other_args: List[str]):
|
||
"""Process sh command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="sh",
|
||
description="""
|
||
Provides the sharpe ratio of the selected stock.
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-r",
|
||
"--rfr",
|
||
action="store",
|
||
dest="rfr",
|
||
type=float,
|
||
default=0,
|
||
help="Risk free return",
|
||
)
|
||
parser.add_argument(
|
||
"-w",
|
||
"--window",
|
||
action="store",
|
||
dest="window",
|
||
type=int,
|
||
default=252,
|
||
help="Rolling window length",
|
||
)
|
||
ns_parser = self.parse_known_args_and_warn(parser, other_args)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
data = self.stock["adjclose"]
|
||
qa_view.display_sharpe(data, ns_parser.rfr, ns_parser.window)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_so(self, other_args: List[str]):
|
||
"""Process so command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="so",
|
||
description="""
|
||
Provides the sortino ratio of the selected stock.
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-t",
|
||
"--target",
|
||
action="store",
|
||
dest="target_return",
|
||
type=float,
|
||
default=0,
|
||
help="Target return",
|
||
)
|
||
parser.add_argument(
|
||
"-a",
|
||
"--adjusted",
|
||
action="store_true",
|
||
default=False,
|
||
dest="adjusted",
|
||
help="If one should adjust the sortino ratio inorder to make it comparable to the sharpe ratio",
|
||
)
|
||
parser.add_argument(
|
||
"-w",
|
||
"--window",
|
||
action="store",
|
||
dest="window",
|
||
type=int,
|
||
default=252,
|
||
help="Rolling window length",
|
||
)
|
||
|
||
ns_parser = self.parse_known_args_and_warn(parser, other_args)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
data = self.stock["returns"]
|
||
qa_view.display_sortino(
|
||
data, ns_parser.target_return, ns_parser.window, ns_parser.adjusted
|
||
)
|
||
|
||
@log_start_end(log=logger)
|
||
def call_om(self, other_args: List[str]):
|
||
"""Process om command"""
|
||
parser = argparse.ArgumentParser(
|
||
add_help=False,
|
||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||
prog="om",
|
||
description="""
|
||
Provides omega ratio of the selected stock.
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-s",
|
||
"--start",
|
||
action="store",
|
||
dest="start",
|
||
type=float,
|
||
default=0,
|
||
help="""
|
||
Start of the omega ratio threshold
|
||
""",
|
||
)
|
||
parser.add_argument(
|
||
"-e",
|
||
"--end",
|
||
action="store",
|
||
dest="end",
|
||
type=float,
|
||
default=1.5,
|
||
help="""
|
||
End of the omega ratio threshold
|
||
""",
|
||
)
|
||
|
||
ns_parser = self.parse_known_args_and_warn(parser, other_args)
|
||
if ns_parser:
|
||
if self.stock.empty:
|
||
no_data_message()
|
||
return
|
||
data = self.stock["returns"]
|
||
qa_view.display_omega(
|
||
data,
|
||
ns_parser.start,
|
||
ns_parser.end,
|
||
)
|