mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-02 23:41:27 +00:00
4ad995fdd0
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
58 lines
1.6 KiB
Markdown
Vendored
58 lines
1.6 KiB
Markdown
Vendored
---
|
|
title: bw
|
|
description: The documentation page depicts the usage and configuration options for
|
|
the 'bw' function in OpenBB Terminal. The function plots box and whisker graphs
|
|
for quantitative data analysis based on provided DataFrame and target. An example
|
|
using stock data for 'AAPL' is provided for a clearer understanding.
|
|
keywords:
|
|
- Box and Whisker Plots
|
|
- Quantitative Analysis
|
|
- Yearly Accumulation
|
|
- External Axes
|
|
- AAPL
|
|
- Adjusted Close
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="qa.bw - Reference | OpenBB SDK Docs" />
|
|
|
|
Plots box and whisker plots
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L270)]
|
|
|
|
```python
|
|
openbb.qa.bw(data: pd.DataFrame, target: str, symbol: str = "", yearly: bool = True, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | str | Name of dataset | | True |
|
|
| data | pd.DataFrame | Dataframe to look at | None | False |
|
|
| target | str | Data column to look at | None | False |
|
|
| yearly | bool | Flag to indicate yearly accumulation | True | 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
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
df = openbb.stocks.load("AAPL")
|
|
openbb.qa.bw(data=df, target="Adj Close")
|
|
```
|
|
|
|
---
|