jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/econometrics/options.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.7 KiB
Vendored
Raw Blame History

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