jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 16:02:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/alt/covid/ov.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* 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>
2023-10-30 21:01:29 +00:00

2.1 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
ov This documentation page provides detailed information on the 'ov' models used for retrieving historical cases and deaths-by-country data. It also explains the parameters required to run these models, and returns in the form of a DataFrame.
docusaurus
ov model
historical data
cases
deaths
country-specific
dataframe
parameters
functions

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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

Get historical cases and deaths by country.

Source Code: [link]

openbb.alt.covid.ov(country: str, limit: int = 100)

Parameters

Name Type Description Default Optional
country str Country to get data for None False
limit int Number of raw data to show 100 True

Returns

Type Description
pd.DataFrame Dataframe of historical cases and deaths

Prints table showing historical cases and deaths by country.

Source Code: [link]

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

Parameters

Name Type Description Default Optional
country str Country to get data for None False
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 display historical plot True True

Returns

This function does not return anything