mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 21:12:16 +00:00
79046608b6
* 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>
92 lines
8.9 KiB
Markdown
Vendored
92 lines
8.9 KiB
Markdown
Vendored
---
|
|
title: roc
|
|
description: OpenBB Terminal Function
|
|
---
|
|
|
|
# roc
|
|
|
|
Add rate of change to dataset based on specific column.
|
|
|
|
### Usage
|
|
|
|
```python
|
|
roc [-d {}] [-c TARGET_COLUMN] [--period PERIOD]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| target_dataset | The name of the dataset you want to select | None | True | None |
|
|
| target_column | The name of the specific column you want to use | close | True | None |
|
|
| period | The period to use | 10 | True | None |
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
(🦋) /forecast/ $ show TSLA
|
|
TSLA dataset has shape (row, column): (611, 7)
|
|
|
|
Dataset TSLA | Showing 10 of 611 rows
|
|
┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓
|
|
┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃
|
|
┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩
|
|
│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤
|
|
│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤
|
|
│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤
|
|
│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤
|
|
│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤
|
|
│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤
|
|
│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤
|
|
│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤
|
|
│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤
|
|
│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │
|
|
└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┘
|
|
|
|
(🦋) /forecast/ $ roc TSLA
|
|
Successfully added 'ROC_10' to 'TSLA' dataset
|
|
|
|
(🦋) /forecast/ $ show TSLA
|
|
TSLA dataset has shape (row, column): (611, 8)
|
|
|
|
Dataset TSLA | Showing 10 of 611 rows
|
|
┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┓
|
|
┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ ROC_10 ┃
|
|
┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━┩
|
|
│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ nan │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤
|
|
│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ nan │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤
|
|
│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ nan │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤
|
|
│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ nan │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤
|
|
│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ nan │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤
|
|
│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ nan │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤
|
|
│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ nan │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤
|
|
│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ nan │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤
|
|
│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ nan │
|
|
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤
|
|
│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ 20.51 │
|
|
└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┴────────┘
|
|
```
|
|
---
|