mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-02 23:41:27 +00:00
4ad995fdd0
* 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>
99 lines
2.7 KiB
Markdown
Vendored
99 lines
2.7 KiB
Markdown
Vendored
---
|
|
title: distr
|
|
description: This page provides documentation on using the 'distr' and 'distr_chart'
|
|
functions in OpenBB Terminal's Portfolio module. Learn how to display daily returns
|
|
and configure parameters like the PortfolioEngine instance and return intervals.
|
|
keywords:
|
|
- OpenBB Terminal documentation
|
|
- Portfolio Module
|
|
- Display Daily Returns
|
|
- PortfolioEngine instance
|
|
- Return intervals
|
|
- distr function
|
|
- distr_chart function
|
|
- Source Code
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="portfolio.distr - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Display daily returns
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L441)]
|
|
|
|
```python
|
|
openbb.portfolio.distr(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.<br/>Use `portfolio.load` to create a PortfolioEngine. | None | False |
|
|
| window | str | interval to compare cumulative returns and benchmark | all | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | DataFrame of returns distribution |
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv")
|
|
output = openbb.portfolio.distr(p)
|
|
```
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Display daily returns
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_view.py#L626)]
|
|
|
|
```python
|
|
openbb.portfolio.distr_chart(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all", raw: bool = False, export: str = "", external_axes: Optional[matplotlib.axes._axes.Axes] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| portfolio_returns | pd.Series | Returns of the portfolio | None | True |
|
|
| benchmark_returns | pd.Series | Returns of the benchmark | None | True |
|
|
| interval | str | interval to compare cumulative returns and benchmark | None | True |
|
|
| raw | False | Display raw data from cumulative return | False | True |
|
|
| export | str | Export certain type of data | | True |
|
|
| external_axes | plt.Axes | Optional axes to display plot on | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|