mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-06-07 23:35:49 +08:00
4ad995fdd0
* 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>
1.2 KiB
Vendored
1.2 KiB
Vendored
title, description, keywords
| title | description | keywords | |||||
|---|---|---|---|---|---|---|---|
| roc | This documentation page provides information and implementation details about the 'roc' (Rate of Change) function in OpenBB, used to calculate momentum oscillations in a given dataset. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
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 |