jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-02 23:41:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/portfolio/om.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

2.8 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
om Learn how to use the omega ratio function to guide your portfolio management. This page provides details about parameters, returns, and examples on how to apply the omega ratio method in your transaction calculations using both model and chart views.
omega ratio
portfolio management
PortfolioEngine class
financial transactions
annualized target return
portfolio load
chart view

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Get omega ratio

Source Code: [link]

openbb.portfolio.om(portfolio_engine: portfolio_engine.PortfolioEngine, threshold_start: float = 0, threshold_end: float = 1.5)

Parameters

Name Type Description Default Optional
portfolio_engine PortfolioEngine PortfolioEngine class instance, this will hold transactions and perform calculations.
Use portfolio.load to create a PortfolioEngine.		 None False
threshold_start float annualized target return threshold start of plotted threshold range 0 True
threshold_end float annualized target return threshold end of plotted threshold range 1.5 True

Returns

Type Description
pd.DataFrame DataFrame with portfolio omega ratio

Examples

from openbb_terminal.sdk import openbb
p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv")
output = openbb.portfolio.om(p)

Display omega ratio

Source Code: [link]

openbb.portfolio.om_chart(portfolio_engine: portfolio_engine.PortfolioEngine, threshold_start: float = 0, threshold_end: float = 1.5)

Parameters

Name Type Description Default Optional
portfolio_engine PortfolioEngine PortfolioEngine class instance, this will hold transactions and perform calculations.
Use portfolio.load to create a PortfolioEngine.		 None False
threshold_start float annualized target return threshold start of plotted threshold range 0 True
threshold_end float annualized target return threshold end of plotted threshold range 1.5 True

Returns

This function does not return anything