Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/qa/hist.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

1.1 KiB
Vendored

title, description
title description
hist OpenBB SDK Function

hist

Plots histogram of data

Source Code: [link]

openbb.qa.hist(data: pd.DataFrame, target: str, symbol: str = "", bins: int = 15, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
data pd.DataFrame Dataframe to look at None False
target str Data column to get histogram of the dataframe None False
symbol str Name of dataset True
bins int Number of bins in histogram 15 True
external_axes Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None None True

Returns

This function does not return anything


Examples

from openbb_terminal.sdk import openbb
df = openbb.stocks.load("AAPL")
openbb.qa.hist(data=df, target="Adj Close")