Files
OpenBB/website/content/terminal/reference/forecast/desc.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

56 lines
3.6 KiB
Markdown
Vendored

---
title: desc
description: OpenBB Terminal Function
---
# desc
Show descriptive statistics of a dataset
### Usage
```python
desc [-d {}]
```
---
## Parameters
| Name | Description | Default | Optional | Choices |
| ---- | ----------- | ------- | -------- | ------- |
| target_dataset | The name of the dataset you want to select | None | True | None |
---
## Examples
```python
(🦋) /forecast/ $ load TSLA.csv
(🦋) /forecast/ $ desc TSLA
Showing Descriptive Statistics for Dataset TSLA
┏━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━┓
┃ ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃
┡━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━━┩
│ count │ 611.00 │ 611.00 │ 611.00 │ 611.00 │ 611.00 │ 611.00 │
├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤
│ mean │ 599.50 │ 613.65 │ 583.85 │ 599.19 │ 599.19 │ 47275047.14 │
├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤
│ std │ 308.73 │ 315.33 │ 300.77 │ 307.95 │ 307.95 │ 35945322.23 │
├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤
│ min │ 74.94 │ 80.97 │ 70.10 │ 72.24 │ 72.24 │ 9800600.00 │
├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤
│ 25% │ 325.09 │ 332.00 │ 304.80 │ 316.07 │ 316.07 │ 23386000.00 │
├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤
│ 50% │ 661.42 │ 672.00 │ 644.60 │ 659.58 │ 659.58 │ 33337300.00 │
├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤
│ 75% │ 830.71 │ 846.82 │ 801.99 │ 822.97 │ 822.97 │ 62445150.00 │
├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤
│ max │ 1234.41 │ 1243.49 │ 1217.00 │ 1229.91 │ 1229.91 │ 304694000.00 │
└───────┴─────────┴─────────┴─────────┴─────────┴───────────┴──────────────┘
```
---