Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/ta/aroon.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

1.8 KiB
Vendored

title, description
title description
aroon OpenBB SDK Function

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

aroon

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