mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 13:32:08 +00:00
f72bc8ccec
* Adding versioning to docs --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: tehcoderer <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 |