jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-30 22:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4e6a2fb5648d7e8ee4fdb31d1ce6ffddbaf701bf
OpenBB/website/content/api/common/qa/spread/_index.md
Colin Delahunty 0b33cb45f8 Adds auto yaml generation (#2587) 
* Began working on docs creator

* Added fixes

* More

* More

* Adding autogen_try.py for OpenBB API doc generation

* OpenBB API docs gen try

* Fixed

* Added fixes

* Added fixes

* subs -> sub

* Updated docs

* Updated docs

Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-09-23 16:43:34 +01:00

1.2 KiB
Vendored
Raw Blame History

To obtain charts, make sure to add chart=True as the last parameter

Get underlying data

common.qa.spread(data: pandas.core.frame.DataFrame, window: int = 14) -> Tuple[pandas.core.frame.DataFrame, pandas.core.frame.DataFrame]

Standard Deviation and Variance

Parameters
----------
data: pd.DataFrame
    DataFrame of targeted data
window: int
    Length of window

Returns
-------
df_sd: pd.DataFrame
    Dataframe of rolling standard deviation
df_var: pd.DataFrame
    Dataframe of rolling standard deviation

Getting charts

common.qa.spread(data: pandas.core.frame.DataFrame, target: str, symbol: str = '', window: int = 14, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True)

View rolling spread

Parameters
----------
data: pd.DataFrame
    Dataframe
target: str
    Column in data to look at
target: str
    Column in data to look at
symbol : str
    Stock ticker
window : int
    Length of window
export: str
    Format to export data
external_axes: Optional[List[plt.Axes]], optional
    External axes (3 axes are expected in the list), by default None