mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 20:42:26 +00:00
generate new doc (#3159)
This commit is contained in:
44
website/content/SDK/common/ta/atr/_index.md
vendored
Normal file
44
website/content/SDK/common/ta/atr/_index.md
vendored
Normal file
@@ -0,0 +1,44 @@
|
||||
To obtain charts, make sure to add `chart=True` as the last parameter
|
||||
|
||||
## Get underlying data
|
||||
### common.ta.atr(high_prices: pandas.core.series.Series, low_prices: pandas.core.series.Series, close_prices: pandas.core.series.Series, window: int = 14, mamode: str = 'ema', offset: int = 0) -> pandas.core.frame.DataFrame
|
||||
|
||||
Average True Range
|
||||
|
||||
Parameters
|
||||
----------
|
||||
high_prices : pd.DataFrame
|
||||
High prices
|
||||
low_prices : pd.DataFrame
|
||||
Low prices
|
||||
close_prices : pd.DataFrame
|
||||
Close prices
|
||||
window : int
|
||||
Length of window
|
||||
mamode: str
|
||||
Type of filter
|
||||
offset : int
|
||||
Offset value
|
||||
|
||||
Returns
|
||||
-------
|
||||
pd.DataFrame
|
||||
Dataframe of atr
|
||||
|
||||
## Getting charts
|
||||
### common.ta.atr(data: pandas.core.frame.DataFrame, symbol: str = '', window: int = 14, mamode: str = 'sma', offset: int = 0, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True)
|
||||
|
||||
Show ATR
|
||||
|
||||
Parameters
|
||||
----------
|
||||
data : pd.DataFrame
|
||||
Dataframe of ohlc prices
|
||||
symbol : str
|
||||
Ticker symbol
|
||||
window : int
|
||||
Length of window to calculate upper channel
|
||||
export : str
|
||||
Format of export file
|
||||
external_axes : Optional[List[plt.Axes]], optional
|
||||
External axes (1 axis is expected in the list), by default None
|
||||
2
website/data/menu/main.yml
vendored
2
website/data/menu/main.yml
vendored
@@ -1786,6 +1786,8 @@ main:
|
||||
ref: /SDK/common/ta/adx
|
||||
- name: aroon
|
||||
ref: /SDK/common/ta/aroon
|
||||
- name: atr
|
||||
ref: /SDK/common/ta/atr
|
||||
- name: bbands
|
||||
ref: /SDK/common/ta/bbands
|
||||
- name: cci
|
||||
|
||||
Reference in New Issue
Block a user