gaintopain
Get Pain-to-Gain ratio based on historical data
Source Code: [link]
openbb.portfolio.metric.gaintopain(portfolio_engine: portfolio_engine.PortfolioEngine)
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 |
Returns
Type | Description |
---|---|
pd.DataFrame | DataFrame of the portfolio's gain-to-pain ratio |
Examples
from openbb_terminal.sdk import openbb
p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv")
output = openbb.portfolio.metric.gaintopain(p)