mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-05-31 06:50:58 +08: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>
1.9 KiB
Vendored
1.9 KiB
Vendored
title, description, keywords
| title | description | keywords | |||||
|---|---|---|---|---|---|---|---|
| summary | This page contains documentation for methods of calculating and displaying summary statistics in the OpenBB Terminal. Tab sections divide the page into different functionalities, including a model overview and a chart view of summary statistics. Details for parameters, return values, and links to the original source code are provided for each method. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Print summary statistics
Source Code: [link]
openbb.qa.summary(data: pd.DataFrame)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| data | pd.DataFrame | Dataframe to get summary statistics for | None | False |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | Summary statistics |
Prints table showing summary statistics
Source Code: [link]
openbb.qa.summary_chart(data: pd.DataFrame, export: str = "")
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| data | pd.DataFrame | DataFrame to get statistics of | None | False |
| export | str | Format to export data | True |
Returns
This function does not return anything