Files
OpenBB/website/content/api/common/qa/bw/_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

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

Get underlying data

common.qa.bw(data: pandas.core.frame.DataFrame, target: str, symbol: str = '', yearly: bool = True, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) -> None

Show box and whisker plots

Parameters
----------
symbol : str
    Name of dataset
data : pd.DataFrame
    Dataframe to look at
target : str
    Data column to look at
yearly : bool
    Flag to indicate yearly accumulation
external_axes : Optional[List[plt.Axes]], optional
    External axes (1 axis is expected in the list), by default None

Getting charts

common.qa.bw(data: pandas.core.frame.DataFrame, target: str, symbol: str = '', yearly: bool = True, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None

Show box and whisker plots

Parameters
----------
symbol : str
    Name of dataset
data : pd.DataFrame
    Dataframe to look at
target : str
    Data column to look at
yearly : bool
    Flag to indicate yearly accumulation
external_axes : Optional[List[plt.Axes]], optional
    External axes (1 axis is expected in the list), by default None