diff --git a/openbb_terminal/portfolio/portfolio_model.py b/openbb_terminal/portfolio/portfolio_model.py index c4fc1fdee41..701ecaabb2f 100644 --- a/openbb_terminal/portfolio/portfolio_model.py +++ b/openbb_terminal/portfolio/portfolio_model.py @@ -52,7 +52,7 @@ def generate_portfolio( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") """ transactions = PortfolioEngine.read_transactions(transactions_file_path) @@ -82,7 +82,7 @@ def get_transactions(portfolio_engine: PortfolioEngine) -> pd.DataFrame: Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.show(p) """ @@ -114,7 +114,7 @@ def set_benchmark( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.bench(p, symbol="SPY") """ @@ -154,7 +154,7 @@ def get_holdings_value(portfolio_engine: PortfolioEngine) -> pd.DataFrame: Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.holdv(p) """ @@ -188,7 +188,7 @@ def get_holdings_percentage( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.holdp(p) """ @@ -227,7 +227,7 @@ def get_yearly_returns( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.yret(p) """ @@ -291,7 +291,7 @@ def get_monthly_returns( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.mret(p) """ @@ -426,7 +426,7 @@ def get_daily_returns( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.dret(p) """ @@ -501,7 +501,7 @@ def get_distribution_returns( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.distr(p) """ @@ -545,7 +545,7 @@ def get_maximum_drawdown( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.maxdd(p) """ @@ -581,7 +581,7 @@ def get_rolling_volatility( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.rvol(p) """ @@ -627,7 +627,7 @@ def get_rolling_sharpe( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.rsharpe(p) """ @@ -675,7 +675,7 @@ def get_rolling_sortino( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.rsort(p) """ @@ -721,7 +721,7 @@ def get_rolling_beta( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.rbeta(p) """ @@ -757,7 +757,7 @@ def get_summary( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.summary(p) """ @@ -849,7 +849,7 @@ def get_assets_allocation( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.alloc.assets(p) """ @@ -893,7 +893,7 @@ def get_sectors_allocation( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.alloc.sectors(p) """ @@ -937,7 +937,7 @@ def get_countries_allocation( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.alloc.countries(p) """ @@ -981,7 +981,7 @@ def get_regions_allocation( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.alloc.regions(p) """ @@ -1015,7 +1015,7 @@ def get_r2_score(portfolio_engine: PortfolioEngine) -> pd.DataFrame: Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.rsquare(p) """ @@ -1053,7 +1053,7 @@ def get_skewness(portfolio_engine: PortfolioEngine) -> pd.DataFrame: Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.skew(p) """ @@ -1100,7 +1100,7 @@ def get_kurtosis(portfolio_engine: PortfolioEngine) -> pd.DataFrame: Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.kurtosis(p) """ @@ -1179,7 +1179,7 @@ def get_volatility(portfolio_engine: PortfolioEngine) -> pd.DataFrame: Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.volatility(p) """ @@ -1232,7 +1232,7 @@ def get_sharpe_ratio( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.sharpe(p) """ @@ -1285,7 +1285,7 @@ def get_sortino_ratio( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.sortino(p) """ @@ -1334,7 +1334,7 @@ def get_maximum_drawdown_ratio(portfolio_engine: PortfolioEngine) -> pd.DataFram Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.maxdrawdown(p) """ @@ -1381,7 +1381,7 @@ def get_gaintopain_ratio(portfolio_engine: PortfolioEngine) -> pd.DataFrame: Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.gaintopain(p) """ @@ -1418,7 +1418,7 @@ def get_tracking_error( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.trackerr(p) """ @@ -1447,7 +1447,7 @@ def get_information_ratio(portfolio_engine: PortfolioEngine) -> pd.DataFrame: Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.information(p) """ @@ -1487,7 +1487,7 @@ def get_tail_ratio( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.tail(p) """ @@ -1516,7 +1516,7 @@ def get_common_sense_ratio(portfolio_engine: PortfolioEngine) -> pd.DataFrame: Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.commonsense(p) """ @@ -1556,7 +1556,7 @@ def get_jensens_alpha( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.jensens(p) """ @@ -1596,7 +1596,7 @@ def get_calmar_ratio( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.calmar(p) """ @@ -1629,7 +1629,7 @@ def get_kelly_criterion(portfolio_engine: PortfolioEngine) -> pd.DataFrame: Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.kelly(p) """ @@ -1652,7 +1652,7 @@ def get_payoff_ratio(portfolio_engine: PortfolioEngine) -> pd.DataFrame: Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.payoff(p) During some time periods there were no losing trades. Thus some values could not be calculated. """ @@ -1680,7 +1680,7 @@ def get_profit_factor(portfolio_engine: PortfolioEngine) -> pd.DataFrame: Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.metric.profitfactor(p) During some time periods there were no losing trades. Thus some values could not be calculated. """ @@ -1713,7 +1713,7 @@ def get_performance_vs_benchmark( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.perf(p) """ @@ -1833,7 +1833,7 @@ def get_var( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.var(p) """ @@ -1876,7 +1876,7 @@ def get_es( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.es(p) """ @@ -1915,7 +1915,7 @@ def get_omega( Examples -------- >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx") >>> output = openbb.portfolio.om(p) """