Files
OpenBB/website/content/sdk/reference/alt/covid/slopes.md
jose-donato 2e7eb4c9b6 New documentation website (#3526)
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.9 KiB
Vendored

title, description
title description
slopes OpenBB SDK Function

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

slopes

Load cases and find slope over period.

Source Code: [link]

openbb.alt.covid.slopes(days_back: int = 30, limit: int = 50, threshold: int = 10000, ascend: bool = False)

Parameters

Name Type Description Default Optional
days_back int Number of historical days to consider 30 True
limit int Number of rows to show 50 True
threshold int Threshold for total number of cases 10000 True
ascend bool Flag to sort in ascending order False True

Returns

Type Description
pd.DataFrame Dataframe containing slopes

Prints table showing countries with the highest case slopes.

Source Code: [link]

openbb.alt.covid.slopes_chart(days_back: int = 30, limit: int = 10, threshold: int = 10000, ascend: bool = False, export: str = "")

Parameters

Name Type Description Default Optional
days_back int Number of historical days to get slope for 30 True
limit int Number to show in table 10 True
ascend bool Flag to sort in ascending order False True
threshold int Threshold for total cases over period 10000 True
export str Format to export data True

Returns

This function does not return anything