jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-31 06:22:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
aafb5a52ff1b71fa82f8a175b76b0bba1bf66c21
OpenBB/website/content/api/common/qa/summary/_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

672 B
Vendored
Raw Blame History

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

Get underlying data

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

Print summary statistics

Parameters
----------
data : pd.DataFrame
    Dataframe to get summary statistics for

Returns
-------
summary : pd.DataFrame
    Summary statistics

Getting charts

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

Show summary statistics

Parameters
----------
data : pd.DataFrame
    DataFrame to get statistics of
export : str
    Format to export data