mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 05:21:48 +00:00
* fix(docs): added margin between sections * feat: removed unused files; updated ga * fix: juan stuff doesnt work * fix: random fix * moon at noon * fix: update docusaurus config * Update controller_doc_classes.py * fix: temp fix * fix: temp fix * Update controller_doc_classes.py * fix: remove old content * fix: taggfix * init * fix: styling and moved file * Update generate_terminal_markdown.py * fix: removed unused images * fix: port new files * Update generate_sdk_markdown.py * Update controller_doc_classes.py Co-authored-by: teh_coderer <me@tehcoderer.com>
824 B
Vendored
824 B
Vendored
title, description
| title | description |
|---|---|
| roc | OpenBB SDK Function |
roc
A momentum oscillator, which measures the percentage change between the current
Source Code: [link]
openbb.forecast.roc(dataset: pd.DataFrame, target_column: str = "close", period: int = 10)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| dataset | pd.DataFrame | The dataset you wish to calculate with | None | False |
| target_column | str | The column you wish to add the ROC to | close | True |
| period | int | Time Span | 10 | True |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | Dataframe with added ROC column |