mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-07 18:01:10 +00:00
f72bc8ccec
* Adding versioning to docs --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: tehcoderer <me@tehcoderer.com>
1.7 KiB
Vendored
1.7 KiB
Vendored
title, description
| title | description |
|---|---|
| options | OpenBB SDK Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
options
Obtain columns-dataset combinations from loaded in datasets that can be used in other commands
Source Code: [link]
openbb.econometrics.options(datasets: Dict[str, pd.DataFrame], dataset_name: str = "")
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| datasets | dict | The available datasets. | None | False |
| dataset_name | str | The dataset you wish to show the options for. | True |
Returns
| Type | Description |
|---|---|
| Dict[Union[str, Any], pd.DataFrame] | A dictionary with a DataFrame for each option. With dataset_name set, only shows one options table. |
Plot custom data
Source Code: [link]
openbb.econometrics.options_chart(datasets: Dict[str, pd.DataFrame], dataset_name: str = None, export: str = "")
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| datasets | dict | The loaded in datasets | None | False |
| dataset_name | str | The name of the dataset you wish to show options for | None | True |
| export | str | Format to export image | True |
Returns
This function does not return anything