mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-02 15:32:04 +00:00
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2.2 KiB
Vendored
2.2 KiB
Vendored
title, description, keywords
| title | description | keywords | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| options | This page details two main functionalities of OpenBB-finance's model and chart components - obtaining columns-dataset combinations from datasets for use in commands and plotting custom data. Code snippets, links to source code, parameters involved, and return types are provided. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
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