Files
OpenBB/website/content/econometrics/options/_index.md
Jeroen Bouma f2ca215132 Econometrics Menu (#1403)
* Add Statistics Menu

* Add Granger Causality test

* Apply Black formatting

* Add Cointegration Tests

* Adjust plotting for Cointegration test

* Add Significant parameter to Cointegration tests

* Move regression functions to seperate .py files

* Progress on Panel Data

* A lot of progress for Panel Data

* Make functions robust and improve documentation

* Re-enable Breusch-Godfrey

* Add modify functionality

* Improve modify functionality

* Add Breusch-Pagan heteroscedasticity test

* Capitalize a word

* Include documentatin for the Statistics Menu

* Update _index.md

* Update _index.md

* Update _index.md

* Fix export statements and add Example datasets

* Update example with Longley's dataset

* Update documentation with a legit source

* Compare the results from each regression models based on the wage_panel dataset

* Updated with all relevant types of regression tables

* Update with all relevant regression types for Panel data

* Update _index.md

* Add change column type, improve OLS, add time and entity effects for FE

* Update documentation and fix a small bug

* Add in Statistics menu, replacing Custom menu

* Remove custom menu

* Add in documentation

* Add in gst files

* Cointegration can be used on any amount of columns

* Add Tests

* Make tests time invariant

* Update Poetry and Requirements

* Change name of Statistics menu to Econometrics menu

* Rename scripts

* Add type in Documentation

* Change names from Statistics to Econometrics

* Add graph

* Update tests with rounding and naming

* Make minor adjustments to fix the tests

* Updating tests : allow extra args for capture

* Apply recorder formatting

* Adding some minor formatting

* Fix error with MyPy

* Attempt to fix MyPy annoyance

* super small style things

* Fix small bugs and add plot command to dwat

* Small description mistake

* Update documentation with missing argument

* Update styling

* Add error handling and add improve show functionality

* Fix merge issue

* Allow import from custom_imports

Co-authored-by: Jeroen Bouma <jeroenbouma@MacBook-Pro-van-Jeroen.local>
Co-authored-by: jmaslek <jmaslek11@gmail.com>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-03-04 21:44:59 +01:00

6.6 KiB
Vendored

usage: options [-n {NAME}] [-h] [--export {csv,json,xlsx}]

Show the column-dataset combination that can be entered within the different functions.

optional arguments:
  -n {NAME}, --name {NAME} 
                        The dataset you would like to show the options for (default: None)
  -h, --help            show this help message (default: False)
  --export {csv,json,xlsx}
                        Export raw data into csv, json, xlsx (default: )

Example:

2022 Feb 28, 04:26 (✨) /econometrics/ $ options
            Options for msft
┏━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
┃ dataset ┃ column    ┃ option         ┃
┡━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
│ msft    │ date      │ date-msft      │
├─────────┼───────────┼────────────────┤
│ msft    │ open      │ open-msft      │
├─────────┼───────────┼────────────────┤
│ msft    │ high      │ high-msft      │
├─────────┼───────────┼────────────────┤
│ msft    │ low       │ low-msft       │
├─────────┼───────────┼────────────────┤
│ msft    │ close     │ close-msft     │
├─────────┼───────────┼────────────────┤
│ msft    │ adj_close │ adj_close-msft │
├─────────┼───────────┼────────────────┤
│ msft    │ volume    │ volume-msft    │
└─────────┴───────────┴────────────────┘
          Options for ll
┏━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓
┃ dataset ┃ column  ┃ option     ┃
┡━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━┩
│ ll      │ totemp  │ totemp-ll  │
├─────────┼─────────┼────────────┤
│ ll      │ gnpdefl │ gnpdefl-ll │
├─────────┼─────────┼────────────┤
│ ll      │ gnp     │ gnp-ll     │
├─────────┼─────────┼────────────┤
│ ll      │ unemp   │ unemp-ll   │
├─────────┼─────────┼────────────┤
│ ll      │ armed   │ armed-ll   │
├─────────┼─────────┼────────────┤
│ ll      │ pop     │ pop-ll     │
├─────────┼─────────┼────────────┤
│ ll      │ year    │ year-ll    │
└─────────┴─────────┴────────────┘
           Options for a96
┏━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━┓
┃ dataset ┃ column   ┃ option       ┃
┡━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━┩
│ a96     │ popul    │ popul-a96    │
├─────────┼──────────┼──────────────┤
│ a96     │ tvnews   │ tvnews-a96   │
├─────────┼──────────┼──────────────┤
│ a96     │ selflr   │ selflr-a96   │
├─────────┼──────────┼──────────────┤
│ a96     │ clinlr   │ clinlr-a96   │
├─────────┼──────────┼──────────────┤
│ a96     │ dolelr   │ dolelr-a96   │
├─────────┼──────────┼──────────────┤
│ a96     │ pid      │ pid-a96      │
├─────────┼──────────┼──────────────┤
│ a96     │ age      │ age-a96      │
├─────────┼──────────┼──────────────┤
│ a96     │ educ     │ educ-a96     │
├─────────┼──────────┼──────────────┤
│ a96     │ income   │ income-a96   │
├─────────┼──────────┼──────────────┤
│ a96     │ vote     │ vote-a96     │
├─────────┼──────────┼──────────────┤
│ a96     │ logpopul │ logpopul-a96 │
└─────────┴──────────┴──────────────┘

2022 Feb 28, 04:27 (✨) /econometrics/ $ options ll
          Options for ll
┏━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓
┃ dataset ┃ column  ┃ option     ┃
┡━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━┩
│ ll      │ totemp  │ totemp-ll  │
├─────────┼─────────┼────────────┤
│ ll      │ gnpdefl │ gnpdefl-ll │
├─────────┼─────────┼────────────┤
│ ll      │ gnp     │ gnp-ll     │
├─────────┼─────────┼────────────┤
│ ll      │ unemp   │ unemp-ll   │
├─────────┼─────────┼────────────┤
│ ll      │ armed   │ armed-ll   │
├─────────┼─────────┼────────────┤
│ ll      │ pop     │ pop-ll     │
├─────────┼─────────┼────────────┤
│ ll      │ year    │ year-ll    │
└─────────┴─────────┴────────────┘