Files
OpenBB/website/content/sdk/reference/crypto/dd/rm.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.4 KiB
Vendored

title, description, keywords
title description keywords
rm The page consists of two main components or features. Initially, it details a function designed to return the roadmap for each individual cryptocurrency, explaining how data can be sorted and what the output will look like. Later, it describes a function aimed at plotting the roadmap for each cryptocurrency, including details on the parameters users will need to understand and adjust for the purpose of the function.
cryptocurrency
roadmap
data sorting
function parameters
plotting
matplotlib
crypto symbol
python programming
dataframe
reverse order
export data

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

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

Returns coin roadmap

Source Code: [link]

openbb.crypto.dd.rm(symbol: str, ascend: bool = True)

Parameters

Name Type Description Default Optional
symbol str Crypto symbol to check roadmap None False
ascend bool reverse order True True

Returns

Type Description
pd.DataFrame roadmap

Plots coin roadmap

Source Code: [link]

openbb.crypto.dd.rm_chart(symbol: str, ascend: bool = True, limit: int = 5, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
symbol str Crypto symbol to check roadmap None False
ascend bool reverse order True True
limit int number to show 5 True
export str Export dataframe data to csv,json,xlsx file 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