Files
OpenBB/website/content/terminal/reference/forecast/atr.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622)
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

6.5 KiB
Vendored

title, description, keywords
title description keywords
atr This page details how to add Average True Range to a stock ticker dataset using the `atr` command. It's a fantastic resource for individuals interested in forecasting and stock market analysis.
Average True Range
dataset
stock ticker
close column
high column
low column
target dataset
target column
forecasting
stock market analysis

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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       │
└───┴────────────┴────────────┴───────┴───────┴───────┴───────┴───────────┴───────────┴────────────┘