mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-07 09:52:13 +00:00
* Adding versioning to docs --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: tehcoderer <me@tehcoderer.com>
485 B
Vendored
485 B
Vendored
title, description
| title | description |
|---|---|
| summary | OpenBB Terminal Function |
summary
Display summary of portfolio vs benchmark
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 |