CryptocurrencyEDAr

This is a R package to analyze historical cryptocurrency prices and performance through simple exploratory data analysis including calculations and plotting. Data is sourced from the KuCoin API. There are four functions that are included in this R package which are described in more detail below. Cryptocurrency investors and enthusiasts can use this package to analyze cryptocurrencies of interest.

There are existing R packages that support users to access information of cryptocurrency such as crypto, crypto2 and coinmarketcapr. Among these 3 packages, only coinmarketcapr provides visualization of top currency. Indeed , there is no integrated R package for retrieving, analyzing, and visualizing cryptocurrency data altogether. Therefore, we want to build a simple tool that can facilitate simple cryptocurrency data analysis all at once.

Function list

The package contains the following four functions:

  • retrieve_data: downloads historical data using an an http request from a cryptocurrency exchange.

  • plot_price: generates and visualizes a plot of the price of the cryptocurrenty inputted over a period of time.

  • daily_growth_rate: performs calculation of daily growth rate of the price of the cryptocurrency inputted over a period of time.

  • avg_daily_return: performs calculation of the average daily return of the inputted cryptocurrency price.

Installation

You can install the development version of CryptocurrencyEDAr from GitHub with:

# install.packages("devtools")
devtools::install_github("UBC-MDS/CryptocurrencyEDAr", quiet = TRUE)

Usage

After installation, firstly load the functions from the package:

devtools::load_all()
#> ℹ Loading CryptocurrencyEDAr

Now the functions are ready to use as follows:

price_df <- retrieve_data("BTC-USDT", "1day", "2021-01-01", "2021-12-31")
plot_price(df = price_df)

new_price_df <- daily_growth_rate(price_df, "Close")
head(new_price_df)
#>     Symbol       Date   Close daily_growth_rate
#> 1 BTC-USDT 2021-12-30 46216.4                NA
#> 2 BTC-USDT 2021-12-29 47122.4         1.9603431
#> 3 BTC-USDT 2021-12-28 46466.4        -1.3921192
#> 4 BTC-USDT 2021-12-27 47543.8         2.3186647
#> 5 BTC-USDT 2021-12-26 50715.7         6.6715324
#> 6 BTC-USDT 2021-12-25 50771.5         0.1100251
avg_daily_return(price_df$Close)
#> [1] -38.65289

Documentation

  • Vignette homepage
  • Introduction to CryptocurrencyEDAr package

Contributors

We welcome and recognize all contributions. The following are current contributors. You can also see the list here. If you are interested in contributing to this project, please check out our CODE_OF_CONDUCT.md

  • Berkay Bulut
  • Cici Du
  • Alex Yinan Guo
  • Nobby Nguyen

License

CryptocurrencyEDAr was created by MDS Students from Group-11 for course DSCI-524. It is licensed under the terms of the MIT license.

Code of Conduct

Please note that the CryptocurrencyEDAr project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.