mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-08 10:22:09 +00:00
* fix(docs): added margin between sections * fix: images * readd old content for examples/images * fix: codespell * fix: codespell * fix: ga * fix: remove temp lorem ipsum * fix: docu config for edit page Co-authored-by: teh_coderer <me@tehcoderer.com>
492 B
Vendored
492 B
Vendored
title, description
| title | description |
|---|---|
| summary | OpenBB Terminal Function |
summary
Display summary of portfolio vs benchmark
Usage
usage: 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 |