jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-29 13:32:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/terminal/reference/forecast/mom.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
Raw Blame History

title, description
title description
mom OpenBB Terminal Function

mom

Add momentum to dataset based on specific column.

Usage

mom [-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

(🦋) /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/ $ mom TSLA
Successfully added 'Momentum_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    ┃ Momentum_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  │ nan         │
└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┴─────────────┘

(🦋) /forecast/ $ clean TSLA
Namespace(drop='', fill='', help=False, limit=5, target_dataset='TSLA')
Successfully cleaned 'TSLA' dataset

(🦋) /forecast/ $ show TSLA
TSLA dataset has shape (row, column): (601, 8)

                           Dataset TSLA | Showing 10 of 601 rows
┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━┓
┃   ┃ date       ┃ open   ┃ high   ┃ low    ┃ close  ┃ adj_close ┃ volume    ┃ Momentum_10 ┃
┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━┩
│ 0 │ 2020-01-16 │ 98.75  │ 102.89 │ 98.43  │ 102.70 │ 102.70    │ 108683500 │ 16.65       │
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤
│ 1 │ 2020-01-17 │ 101.52 │ 103.13 │ 100.63 │ 102.10 │ 102.10    │ 68145500  │ 13.50       │
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤
│ 2 │ 2020-01-21 │ 106.05 │ 109.72 │ 105.68 │ 109.44 │ 109.44    │ 89017500  │ 19.13       │
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤
│ 3 │ 2020-01-22 │ 114.38 │ 118.90 │ 111.82 │ 113.91 │ 113.91    │ 156845000 │ 20.10       │
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤
│ 4 │ 2020-01-23 │ 112.85 │ 116.40 │ 111.12 │ 114.44 │ 114.44    │ 98255000  │ 16.01       │
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤
│ 5 │ 2020-01-24 │ 114.13 │ 114.77 │ 110.85 │ 112.96 │ 112.96    │ 71768000  │ 16.70       │
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤
│ 6 │ 2020-01-27 │ 108.40 │ 112.89 │ 107.86 │ 111.60 │ 111.60    │ 68040500  │ 15.97       │
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤
│ 7 │ 2020-01-28 │ 113.70 │ 115.36 │ 111.62 │ 113.38 │ 113.38    │ 58942500  │ 8.41        │
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤
│ 8 │ 2020-01-29 │ 115.14 │ 117.96 │ 113.49 │ 116.20 │ 116.20    │ 89007500  │ 8.61        │
├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤
│ 9 │ 2020-01-30 │ 126.48 │ 130.18 │ 123.60 │ 128.16 │ 128.16    │ 145028500 │ 24.46       │
└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┴─────────────┘