Files
OpenBB/website/content/sdk/reference/ta/aroon.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

2.4 KiB
Vendored

title, description, keywords
title description keywords
aroon This documentation page provides an in-depth overview of the Aroon technical indicator within the OpenBBTerminal. It covers the model and chart view of the Aroon indicator, with detailed parameters and source code. It also provides the functionality to plot the Aroon indicator and export data.
aroon
technical indicator
openbb.ta
openbb.ta.aroon
openbb.ta.aroon_chart
trend indicators
OHLC price data
plotting
matplotlib
axes
scalar
window
symbol
export

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

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Aroon technical indicator

Source Code: [link]

openbb.ta.aroon(data: pd.DataFrame, window: int = 25, scalar: int = 100)

Parameters

Name Type Description Default Optional
data pd.DataFrame Dataframe with OHLC price data None False
window int Length of window 25 True
scalar int Scalar variable 100 True

Returns

Type Description
pd.DataFrame DataFrame with aroon indicator

Plots Aroon indicator

Source Code: [link]

openbb.ta.aroon_chart(data: pd.DataFrame, window: int = 25, scalar: int = 100, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
data pd.DataFrame Dataframe with OHLC price data None False
window int Length of window 25 True
symbol str Ticker True
scalar int Scalar variable 100 True
export str Format to export data True
external_axes Optional[List[plt.Axes]] External axes (3 axes are expected in the list), by default None None True

Returns

This function does not return anything