mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 05:21:48 +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>
6.0 KiB
Vendored
6.0 KiB
Vendored
title, description
| title | description |
|---|---|
| atr | OpenBB Terminal Function |
atr
Add Average True Range to dataset of specific stock ticker.
Usage
atr [--close-col CLOSE_COL] [--high-col HIGH_COL] [--low-col LOW_COL] [-d {}] [-c TARGET_COLUMN]
Parameters
| Name | Description | Default | Optional | Choices |
|---|---|---|---|---|
| close_col | Close column name to use for Average True Range. | close | True | None |
| high_col | High column name to use for Average True Range. | high | True | None |
| low_col | Low column name to use for Average True Range. | low | True | None |
| 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 |
Examples
(🦋) /forecast/ $ load aapl_20220628_113243.csv
(🦋) /forecast/ $ atr aapl_20220628_113243
Successfully added 'Average True Range' to 'aapl_20220628_113243' dataset
(🦋) /forecast/ $ show aapl_20220628_113243
aapl_20220628_113243 dataset has shape (row, column): (759, 9)
Dataset aapl_20220628_113243 | Showing 10 of 759 rows
┏━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ ┃ unnamed:_0 ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ true_range ┃
┡━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ 0 │ 0 │ 2019-06-10 │ 47.95 │ 48.84 │ 47.90 │ 48.15 │ 46.99 │ 104883600 │ 0.94 │
├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤
│ 1 │ 1 │ 2019-06-11 │ 48.72 │ 49.00 │ 48.40 │ 48.70 │ 47.53 │ 107731600 │ 0.85 │
├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤
│ 2 │ 2 │ 2019-06-12 │ 48.49 │ 48.99 │ 48.35 │ 48.55 │ 47.38 │ 73012800 │ 0.65 │
├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤
│ 3 │ 3 │ 2019-06-13 │ 48.67 │ 49.20 │ 48.40 │ 48.54 │ 47.37 │ 86698400 │ 0.80 │
├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤
│ 4 │ 4 │ 2019-06-14 │ 47.89 │ 48.40 │ 47.58 │ 48.19 │ 47.03 │ 75046000 │ 0.96 │
├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤
│ 5 │ 5 │ 2019-06-17 │ 48.22 │ 48.74 │ 48.04 │ 48.47 │ 47.31 │ 58676400 │ 0.70 │
├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤
│ 6 │ 6 │ 2019-06-18 │ 49.01 │ 50.07 │ 48.80 │ 49.61 │ 48.42 │ 106204000 │ 1.60 │
├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤
│ 7 │ 7 │ 2019-06-19 │ 49.92 │ 49.97 │ 49.33 │ 49.47 │ 48.28 │ 84496800 │ 0.64 │
├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤
│ 8 │ 8 │ 2019-06-20 │ 50.09 │ 50.15 │ 49.51 │ 49.87 │ 48.67 │ 86056000 │ 0.69 │
├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤
│ 9 │ 9 │ 2019-06-21 │ 49.70 │ 50.21 │ 49.54 │ 49.69 │ 48.50 │ 191202400 │ 0.68 │
└───┴────────────┴────────────┴───────┴───────┴───────┴───────┴───────────┴───────────┴────────────┘