jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 07:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/economy/bigmac.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* 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>
2023-10-30 21:01:29 +00:00

2.4 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
bigmac This page provides documentation for the Big Mac Index functionality in OpenBB. It includes details on how to use the 'bigmac' function and its parameters, along with source code links and return information. This information is useful for individuals looking to utilize the OpenBB economic dataset for data analysis.
bigmac
docusaurus
Big Mac Index
economy
country_codes
dataframe
matplotlib
USD equivalent
parameters
returns

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Display Big Mac Index for given countries

Source Code: [link]

openbb.economy.bigmac(country_codes: List[str] = None)

Parameters

Name Type Description Default Optional
country_codes List[str] List of country codes (ISO-3 letter country code). Codes available through economy.country_codes(). None True

Returns

Type Description
pd.DataFrame Dataframe with Big Mac indices converted to USD equivalent.

Display Big Mac Index for given countries

Source Code: [link]

openbb.economy.bigmac_chart(country_codes: List[str] = None, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
country_codes List[str] List of country codes (ISO-3 letter country code). Codes available through economy.country_codes(). None True
raw bool Flag to display raw data, by default False False True
export str Format data, by default "" True
external_axes Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None None True

Returns

This function does not return anything