README.md

Cryptics 0.0

GitHub Logo

Installation

Prior to download this package, make sure you have "usethis" and "devtools" installed and loaded :

install.packages("usethis")
library(usethis)
install.packages("devtools")
library(devtools)

Then, download and load the package. Finally, load the included data :

install_github("VincentKV/Cryptics")
library(Cryptics)
data("cryptolist")

Functions

Symbol check

If you want to check that a cryptocurrency is supported by the package, you need to type in its symbol. For example, "BTC" for Bitcoin. GitHub Logo

If you are not sure about the exact symbol, symbolCheck() provides you suggestions. GitHub Logo

View all cryptocurrencies

You can also visualize all the cryptocurrencies supported by the Cryptics package, and sort the columns alphabetically for a quicker search with View(cryptolist). GitHub Logo

Cryptocurrency course

Get the daily data (Open, High, Low, Close, Adjusted, Volume) of a particular cryptocurrency from its creation until today. Returns a time series. GitHub Logo

The default is Bitcoin in US Dollar. GitHub Logo

Normalized cryptocurrency course

Normalize a course between 0 and 1 to easily compare cryptocurrencies and work with percentages. The values taken are the "Opens". 1 is the all-time-high. Returns a time series. GitHub Logo

Return on investment

Compute the simple gain or loss given a specific cryptocurrency and a particular amount of money invested in it during a period of time. Currency does not matter. 20 euros (or dollars...) invested in Litecoin on 2021-01-01 would be 31.69 euros on 2021-04-01. Prints the creation date of the cryptocurrency. GitHub Logo

The default is Bitcoin with today as end date. 20 euros invested in Bitcoin on 2021-02-01 would be 327.52 euros today. GitHub Logo

Historical data graph

Plot an interactive graph with the historical data of a single cryptocurrency. You can normalize the graph or apply the logarithm. The default is Bitcoin in US Dollar. USD is advised as there is older data in this currency. Prints the creation date of the cryptocurrency. GitHub Logo GitHub Logo

Candlestick chart

Plots an interactive graph with the candlestick chart of a single cryptocurrency. You can also normalize the graph or apply the logarithm. The default is Bitcoin in US Dollar, on the last 30 days. Prints the creation date of the cryptocurrency. GitHub Logo GitHub Logo

Wallet

The wallet is the perfect way to keep track on an investment. Compute the time series of earnings and losses given a specific cryptocurrency and a particular amount of money invested in it during a period of time. The default is Bitcoin with today as end date. GitHub Logo

Portfolio

The portfolio takes the list of your wallets and compute the time series of your total earnings and losses. GitHub Logo

Coin tracker graph

Plot an interactive graph with the historical data of your portfolio. GitHub Logo GitHub Logo



VincentKV/Cryptics documentation built on Dec. 18, 2021, 6:18 p.m.