jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-05 08:51:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4e6a2fb5648d7e8ee4fdb31d1ce6ffddbaf701bf
OpenBB/website/content/api/common/qa/normality/_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

983 B
Vendored
Raw Blame History

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

Get underlying data

common.qa.normality(data: pandas.core.frame.DataFrame) -> pandas.core.frame.DataFrame

Look at the distribution of returns and generate statistics on the relation to the normal curve.
This function calculates skew and kurtosis (the third and fourth moments) and performs both
a Jarque-Bera and Shapiro Wilk test to determine if data is normally distributed.

Parameters
----------
data : pd.DataFrame
    Dataframe of targeted data

Returns
-------
pd.DataFrame
    Dataframe containing statistics of normality

Getting charts

common.qa.normality(data: pandas.core.frame.DataFrame, target: str, export: str = '', chart=True) -> None

View normality statistics

Parameters
----------
data : pd.DataFrame
    DataFrame
target : str
    Column in data to look at
export : str
    Format to export data