jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-29 21:42:22 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7c57fb71c5bc1032dfd4ef4f3edfc74afa8c0a2e
OpenBB/website/content/sdk/reference/portfolio/alloc/sectors.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.2 KiB
Vendored
Raw Blame History

title, description
title description
sectors OpenBB SDK Function

sectors

Display portfolio sector allocation compared to the benchmark

Source Code: [link]

openbb.portfolio.alloc.sectors(portfolio_engine: portfolio_engine.PortfolioEngine, limit: int = 10, tables: bool = False, recalculate: bool = False)

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
tables bool Whether to include separate allocation tables False True
limit int The amount of assets you wish to show, by default this is set to 10 10 True
recalculate bool Flag to force recalculate allocation if already exists False True

Returns

Type Description
Union[pd.DataFrame, Tuple[pd.DataFrame, pd.DataFrame, pd.DataFrame]] DataFrame with combined allocation plus individual allocation if tables is True.