Files
OpenBB/website/content/terminal/reference/econometrics/plot.md
James Maslek 747c53512d Release/3.2.4 (#5696)
* test

* ultima description (#5541)

* Updating showcase page (#5543)

* updating showcase page

* use sdk instead

* add new bot command autopost docs (#5530)

add new bot command autopost docs to docs.openbb.co

Co-authored-by: James Maslek <jmaslek11@gmail.com>

* Hotfix/ultima improvements (#5553)

* tweaks for monetization

* fix linting issue

* fix: Modify 'load' behavior to append data to existing sheet (#5503)

* fix: Modify 'load' behavior to append data to existing sheet

Details:
- Added logic to detect existing sheet and append data if present.
- There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number.

Resolves: #5472

* Fixed 'worksheet not found' error during export to an existing sheet

* Changes:
* Now if the sheet exists in the xlsx file it will ask the user if he
  wants to replace/append/create new sheet

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>

* added platform API integration test to Nightly build (#5571)

* Add columns to `stocks/search` (#5565)

* Add columns to `stocks/search`

isin, cusip, figi, composite_figi, shareclass_figi

* Update test_search[False].txt

* Update test_search[True].txt

* Delete tests/openbb_terminal/stocks/cassettes/test_stocks_helper/test_search.yaml

* Create test_search.yaml

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>

* updating ultima urls (#5587)

* fix: A value is trying to be set on a copy of a slice from a DataFrame #5582 (#5591)

* Update README.md (#5598)

* Hotfix/econometrics export filename fix (#5508)

* fix: Modify 'load' behavior to append data to existing sheet

Details:
- Added logic to detect existing sheet and append data if present.
- There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number.

Resolves: #5472

* Added --export option for exporting to a desired file in /econometrics menu

* Added a -f/--file option to provide the filename for export.
Made -t/--type and -f/--file mutually exclusive.
If -f is not given, -t is required and the filename will be generated based on the time and module.

* Revert `helper_funcs.py` to original state

* Made some arguments not required.

* Minor changes asked by @deeleeramone

* No sheet name

* black

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>

* FIX #5600 Updated the Twitter logo to X logo (#5601)

* Change Ultima paragraph (#5624)

* change ultima paragraph

* remove old paragraph

* Update CONTRIBUTING.md (#5623)

* mobile line-brake fixed (#5604)

In the mobile view (media max 400px ), the text line "Installation >>" appears broken into smaller segments.

Co-authored-by: James Maslek <jmaslek11@gmail.com>

* 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>

* Add light blue banner, blue when clicking sidebar + fix link in docusaurus.config.js (#5627)

* typo

* pro docs tab coloring

* sidebar selection blue

* redirecting missing

* fix docs (#5646)

* Fix the redirect for intro to the correct url for docs (#5658)

* fix the redirect for intro to the correct url for docs

* fix code linting

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>

* Improve Pro documentation further (#5641)

* small improvement

* Fix TutorialVideo for mobile view

* main page terminal pro docs

* jose whelp

* placeholder index file that needs to be removed

* fix: fixes sidebar, removes unused index.md

* update link to api keys

* update api keys link

* fix hyperlinks in terminal helper

* fix a few more links

* fix some more links

* linter

* black linter

* improve main docs page for each product

* small refactor

* header to take to main page of product

* run OpenAI script to generate SEO for pro content

---------

Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>

* Update folders.md

* Update integrate-your-own-backend.md

* Update index.md

* Update settings.md (#5665)

* fix front matter (#5667)

* #5633 adding comma every 1000 (#5652)

* #5633 adding comma every 1000

* pylint

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>

* Hotfix/reports model render report sanitize inputs (#5669)

* Adding more robust special character handling to create_output_path().Addresses https://github.com/OpenBB-finance/OpenBBTerminal/issues/5299

* Running black linter on code to conform to OBB style guides.

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>

* hotfix/fix-gov-histcont: Fix #5650 - /stocks/gov/histcont (#5676)

* fix histcont

* some cleanup

* remove sort line

* 12-31 not 12-12

* columns_keep_types

* remove space in regex (#5675)

* Pin openai (#5685)

* Clarified stocks/ta empty recom object message (#5468)

* Clarified stocks/ta empty recom object message

* black

* lint

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>

* improved market cap value extraction (#5169)

* improved market cap value extraction

* pylint

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>

* 3.2.3->3.2.4

* Changelogs

* new changelog

---------

Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt>
Co-authored-by: Andrew <andrew.kenreich@gmail.com>
Co-authored-by: Adi Sai <adithya.sairam1@gmail.com>
Co-authored-by: Sandip Saha <sandipsmoto@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Luqman <luqazino@gmail.com>
Co-authored-by: Adwait <111136306+AdwaitSalankar@users.noreply.github.com>
Co-authored-by: Abhishek Amar <66067391+abhishek-amar@users.noreply.github.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: professssor <62937125+professssor@users.noreply.github.com>
Co-authored-by: Farookh Zaheer Siddiqui <129654632+FarukhS52@users.noreply.github.com>
Co-authored-by: MAX SHESTOV <57421753+maxxsh@users.noreply.github.com>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: Mohamad Fadil <fadil.parves@gmail.com>
Co-authored-by: Ramazan <guvencramazan@outlook.com>
Co-authored-by: joshuabuildsthings <joshuabuildsthings@users.noreply.github.com>
Co-authored-by: wojda <114031148+polooner@users.noreply.github.com>
Co-authored-by: Bim Phomthong <118195204+bimbolimbo@users.noreply.github.com>
2023-11-09 15:48:33 -05:00

79 lines
7.9 KiB
Markdown
Vendored

---
title: plot
description: This page provides documentation for the 'plot' command used in Python
scripting. The command is intended for plotting data based on a specified column
from a dataset with usage examples and parameter explanations.
keywords:
- Python scripting
- data plotting
- command usage
- dataset
- econometrics
- tutorial
- SEO optimization
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="econometrics /plot - Reference | OpenBB Terminal Docs" />
Plot data based on the index
### Usage
```python
plot [-v VALUES]
```
---
## Parameters
| Name | Description | Default | Optional | Choices |
| ---- | ----------- | ------- | -------- | ------- |
| values | Dataset.column values to be displayed in a plot | None | True | None |
---
## Examples
```python
2022 Jun 01, 06:45 (🦋) /econometrics/ $ load macrodata -a us_macro
2022 Jun 01, 06:45 (🦋) /econometrics/ $ index us_macro -i year -d
Successfully updated 'us_macro' index to be 'year'
2022 Jun 01, 06:46 (🦋) /econometrics/ $ show us_macro
Dataset us_macro | Showing 10 of 203 rows
┏━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━━┳━━━━━━━┳━━━━━━━━━┓
┃ ┃ quarter ┃ realgdp ┃ realcons ┃ realinv ┃ realgovt ┃ realdpi ┃ cpi ┃ m1 ┃ tbilrate ┃ unemp ┃ pop ┃ infl ┃ realint ┃
┡━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━━╇━━━━━━━╇━━━━━━━━━┩
│ 1959.0 │ 1.00 │ 2710.35 │ 1707.40 │ 286.90 │ 470.05 │ 1886.90 │ 28.98 │ 139.70 │ 2.82 │ 5.80 │ 177.15 │ 0.00 │ 0.00 │
├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤
│ 1959.0 │ 2.00 │ 2778.80 │ 1733.70 │ 310.86 │ 481.30 │ 1919.70 │ 29.15 │ 141.70 │ 3.08 │ 5.10 │ 177.83 │ 2.34 │ 0.74 │
├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤
│ 1959.0 │ 3.00 │ 2775.49 │ 1751.80 │ 289.23 │ 491.26 │ 1916.40 │ 29.35 │ 140.50 │ 3.82 │ 5.30 │ 178.66 │ 2.74 │ 1.09 │
├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤
│ 1959.0 │ 4.00 │ 2785.20 │ 1753.70 │ 299.36 │ 484.05 │ 1931.30 │ 29.37 │ 140.00 │ 4.33 │ 5.60 │ 179.39 │ 0.27 │ 4.06 │
├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤
│ 1960.0 │ 1.00 │ 2847.70 │ 1770.50 │ 331.72 │ 462.20 │ 1955.50 │ 29.54 │ 139.60 │ 3.50 │ 5.20 │ 180.01 │ 2.31 │ 1.19 │
├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤
│ 1960.0 │ 2.00 │ 2834.39 │ 1792.90 │ 298.15 │ 460.40 │ 1966.10 │ 29.55 │ 140.20 │ 2.68 │ 5.20 │ 180.67 │ 0.14 │ 2.55 │
├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤
│ 1960.0 │ 3.00 │ 2839.02 │ 1785.80 │ 296.38 │ 474.68 │ 1967.80 │ 29.75 │ 140.90 │ 2.36 │ 5.60 │ 181.53 │ 2.70 │ -0.34 │
├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤
│ 1960.0 │ 4.00 │ 2802.62 │ 1788.20 │ 259.76 │ 476.43 │ 1966.60 │ 29.84 │ 141.10 │ 2.29 │ 6.30 │ 182.29 │ 1.21 │ 1.08 │
├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤
│ 1961.0 │ 1.00 │ 2819.26 │ 1787.70 │ 266.40 │ 475.85 │ 1984.50 │ 29.81 │ 142.10 │ 2.37 │ 6.80 │ 182.99 │ -0.40 │ 2.77 │
├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤
│ 1961.0 │ 2.00 │ 2872.01 │ 1814.30 │ 286.25 │ 480.33 │ 2014.40 │ 29.92 │ 142.90 │ 2.29 │ 7.00 │ 183.69 │ 1.47 │ 0.81 │
└────────┴─────────┴─────────┴──────────┴─────────┴──────────┴─────────┴───────┴────────┴──────────┴───────┴────────┴───────┴─────────┘
2022 Jun 01, 06:44 (🦋) /econometrics/ $ plot us_macro.unemp
```
![unemp_data_us](https://user-images.githubusercontent.com/46355364/156058283-3888c6a8-a9a7-41c6-a091-b94b7946679b.png)
---