mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-13 12:51:49 +00:00

Files

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

title, description

title	description
stat	OpenBB SDK Function

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

stat

Show historical cases and deaths by country.

Source Code: [link]

openbb.alt.covid.stat(country: str, stat: str = "cases", limit: int = 10)

Parameters

Name	Type	Description	Default	Optional
country	str	Country to get data for	None	False
stat	str	Statistic to get. Either "cases", "deaths" or "rates"	cases	True
limit	int	Number of raw data to show	10	True

Type	Description
pd.DataFrame	Dataframe of data for given country and statistic

Prints table showing historical cases and deaths by country.

Source Code: [link]

openbb.alt.covid.stat_chart(country: str, stat: str = "cases", raw: bool = False, limit: int = 10, export: str = "", plot: bool = True)

Name	Type	Description	Default	Optional
country	str	Country to get data for	None	False
stat	str	Statistic to get. Either "cases", "deaths" or "rates"	cases	True
raw	bool	Flag to display raw data	False	True
limit	int	Number of raw data to show	10	True
export	str	Format to export data		True
plot	bool	Flag to plot data	True	True

This function does not return anything