Files
OpenBB/website/content/terminal/reference/econometrics/show.md
teh_coderer 79046608b6 Docs Fix (#3543)
* Update generate_terminal_markdown.py

* updates

* update workflows

* Automated Change

* tests

* tests

* Automated Change

* Update test_generate_docs.py

* Automated Change

* updates

* Automated Change

* Update gen-docs.yml

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* test

* Automated Change

* testtt23

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Automated Change

* added empting reference folders before autogen docs

* updates

* Automated Change

* update tests gitactions

* Automated Change

* up

* Automated Change

* Automated Change

* update pytest

* Automated Change

* tests

* Automated Change

* examples update

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Update test.yml

* Update generate_sdk_markdown.py

* strip

* Automated Change

* Workflow : check test update

* Automated Change

* Automated Change

* Automated Change

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Automated Change

* up

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* update workflows

* fix guides

* testing

* Update gh-pages.yml

* Update gh-pages.yml

Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
Co-authored-by: Chavithra <Chavithra@users.noreply.github.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2022-11-25 17:19:08 -05:00

14 KiB
Vendored

title, description
title description
show OpenBB Terminal Function

show

Show a portion of the DataFrame

Usage

show [-n {}] [-s SORTBY] [-r]

Parameters

Name Description Default Optional Choices
name The name of the database you want to show data for None True None
sortby Sort based on a column in the DataFrame True None
reverse Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. False True None

Examples

2022 Mar 04, 05:57 (🦋) /econometrics/ $ load longley -a ll

2022 Mar 04, 05:57 (🦋) /econometrics/ $ index ll -i year -d

2022 Mar 04, 05:57 (🦋) /econometrics/ $ show ll -s unemp

                    Dataset ll | Showing 10 of 16 rows
┏━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┓
┃        ┃ totemp   ┃ gnpdefl ┃ gnp       ┃ unemp   ┃ armed   ┃ pop       ┃
┡━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━┩
│ 1961.0 │ 69331.00 │ 115.70  │ 518173.00 │ 4806.00 │ 2572.00 │ 127852.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1958.0 │ 66513.00 │ 110.80  │ 444546.00 │ 4681.00 │ 2637.00 │ 121950.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1962.0 │ 70551.00 │ 116.90  │ 554894.00 │ 4007.00 │ 2827.00 │ 130081.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1960.0 │ 69564.00 │ 114.20  │ 502601.00 │ 3931.00 │ 2514.00 │ 125368.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1959.0 │ 68655.00 │ 112.60  │ 482704.00 │ 3813.00 │ 2552.00 │ 123366.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1949.0 │ 60171.00 │ 88.20   │ 258054.00 │ 3682.00 │ 1616.00 │ 109773.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1954.0 │ 63761.00 │ 100.00  │ 363112.00 │ 3578.00 │ 3350.00 │ 116219.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1950.0 │ 61187.00 │ 89.50   │ 284599.00 │ 3351.00 │ 1650.00 │ 110929.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1957.0 │ 68169.00 │ 108.40  │ 442769.00 │ 2936.00 │ 2798.00 │ 120445.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1955.0 │ 66019.00 │ 101.20  │ 397469.00 │ 2904.00 │ 3048.00 │ 117388.00 │
└────────┴──────────┴─────────┴───────────┴─────────┴─────────┴───────────┘

2022 Mar 04, 05:57 (🦋) /econometrics/ $ load wage_panel -a wp

2022 Mar 04, 05:58 (🦋) /econometrics/ $ show
                    Dataset ll | Showing 10 of 16 rows
┏━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┓
┃        ┃ totemp   ┃ gnpdefl ┃ gnp       ┃ unemp   ┃ armed   ┃ pop       ┃
┡━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━┩
│ 1947.0 │ 60323.00 │ 83.00   │ 234289.00 │ 2356.00 │ 1590.00 │ 107608.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1948.0 │ 61122.00 │ 88.50   │ 259426.00 │ 2325.00 │ 1456.00 │ 108632.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1949.0 │ 60171.00 │ 88.20   │ 258054.00 │ 3682.00 │ 1616.00 │ 109773.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1950.0 │ 61187.00 │ 89.50   │ 284599.00 │ 3351.00 │ 1650.00 │ 110929.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1951.0 │ 63221.00 │ 96.20   │ 328975.00 │ 2099.00 │ 3099.00 │ 112075.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1952.0 │ 63639.00 │ 98.10   │ 346999.00 │ 1932.00 │ 3594.00 │ 113270.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1953.0 │ 64989.00 │ 99.00   │ 365385.00 │ 1870.00 │ 3547.00 │ 115094.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1954.0 │ 63761.00 │ 100.00  │ 363112.00 │ 3578.00 │ 3350.00 │ 116219.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1955.0 │ 66019.00 │ 101.20  │ 397469.00 │ 2904.00 │ 3048.00 │ 117388.00 │
├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤
│ 1956.0 │ 67857.00 │ 104.60  │ 419180.00 │ 2822.00 │ 2857.00 │ 118734.00 │
└────────┴──────────┴─────────┴───────────┴─────────┴─────────┴───────────┘

                                      Dataset wp | Showing 10 of 4360 rows
┏━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓
┃   ┃ nr    ┃ year    ┃ black ┃ exper ┃ hisp ┃ hours   ┃ married ┃ educ  ┃ union ┃ lwage ┃ expersq ┃ occupation ┃
┡━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━┩
│ 0 │ 13.00 │ 1980.00 │ 0.00  │ 1.00  │ 0.00 │ 2672.00 │ 0.00    │ 14.00 │ 0.00  │ 1.20  │ 1.00    │ 9.00       │
├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤
│ 1 │ 13.00 │ 1981.00 │ 0.00  │ 2.00  │ 0.00 │ 2320.00 │ 0.00    │ 14.00 │ 1.00  │ 1.85  │ 4.00    │ 9.00       │
├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤
│ 2 │ 13.00 │ 1982.00 │ 0.00  │ 3.00  │ 0.00 │ 2940.00 │ 0.00    │ 14.00 │ 0.00  │ 1.34  │ 9.00    │ 9.00       │
├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤
│ 3 │ 13.00 │ 1983.00 │ 0.00  │ 4.00  │ 0.00 │ 2960.00 │ 0.00    │ 14.00 │ 0.00  │ 1.43  │ 16.00   │ 9.00       │
├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤
│ 4 │ 13.00 │ 1984.00 │ 0.00  │ 5.00  │ 0.00 │ 3071.00 │ 0.00    │ 14.00 │ 0.00  │ 1.57  │ 25.00   │ 5.00       │
├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤
│ 5 │ 13.00 │ 1985.00 │ 0.00  │ 6.00  │ 0.00 │ 2864.00 │ 0.00    │ 14.00 │ 0.00  │ 1.70  │ 36.00   │ 2.00       │
├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤
│ 6 │ 13.00 │ 1986.00 │ 0.00  │ 7.00  │ 0.00 │ 2994.00 │ 0.00    │ 14.00 │ 0.00  │ -0.72 │ 49.00   │ 2.00       │
├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤
│ 7 │ 13.00 │ 1987.00 │ 0.00  │ 8.00  │ 0.00 │ 2640.00 │ 0.00    │ 14.00 │ 0.00  │ 1.67  │ 64.00   │ 2.00       │
├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤
│ 8 │ 17.00 │ 1980.00 │ 0.00  │ 4.00  │ 0.00 │ 2484.00 │ 0.00    │ 13.00 │ 0.00  │ 1.68  │ 16.00   │ 2.00       │
├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤
│ 9 │ 17.00 │ 1981.00 │ 0.00  │ 5.00  │ 0.00 │ 2804.00 │ 0.00    │ 13.00 │ 0.00  │ 1.52  │ 25.00   │ 2.00       │
└───┴───────┴─────────┴───────┴───────┴──────┴─────────┴─────────┴───────┴───────┴───────┴─────────┴────────────┘