Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/portfolio/rbeta.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

2.1 KiB
Vendored

title, description
title description
rbeta OpenBB SDK Function

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

rbeta

Get rolling beta using portfolio and benchmark returns

Source Code: [link]

openbb.portfolio.rbeta(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "1y")

Parameters

Name Type Description Default Optional
portfolio PortfolioEngine PortfolioEngine object None True
window string Interval used for rolling values.
Possible options: mtd, qtd, ytd, 1d, 5d, 10d, 1m, 3m, 6m, 1y, 3y, 5y, 10y.
1y True

Returns

Type Description
pd.DataFrame DataFrame of the portfolio's rolling beta

Examples

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

Display rolling beta

Source Code: [link]

openbb.portfolio.rbeta_chart(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "1y", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
portfolio PortfolioEngine PortfolioEngine object None True
window str interval for window to consider
Possible options: mtd, qtd, ytd, 1d, 5d, 10d, 1m, 3m, 6m, 1y, 3y, 5y, 10y.
1y True
export str Export to file True
external_axes Optional[List[plt.Axes]] Optional axes to display plot on None True

Returns

This function does not return anything