mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +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>
38 lines
850 B
Markdown
Vendored
38 lines
850 B
Markdown
Vendored
---
|
|
title: summary
|
|
description: The page provides a detailed guide on how to display a summary of portfolio
|
|
vs benchmark. It explains the usage, parameters, and choices available.
|
|
keywords:
|
|
- summary
|
|
- portfolio
|
|
- benchmark
|
|
- Usage
|
|
- parameters
|
|
- period
|
|
- risk_free_rate
|
|
- calculations
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="portfolio/summary - Reference | OpenBB Terminal Docs" />
|
|
|
|
Display summary of portfolio vs benchmark
|
|
|
|
### Usage
|
|
|
|
```python
|
|
summary [-p PERIOD] [-r RISK_FREE_RATE]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| period | The file to be loaded | all | True | mtd, qtd, ytd, 3m, 6m, 1y, 3y, 5y, 10y, all |
|
|
| risk_free_rate | Set risk free rate for calculations. | 0 | True | None |
|
|
|
|
---
|