README.md

In szigony/xchangeR: xchangeR package for USD/EUR exchange rate

xchangeR

A package to acquire the EUR/USD exchange rates from the Exchange Rates API and format the numbers as euros. It also allows for easy conversion of USD to EUR.

This package was created as the take-home assignment for Mastering R skills at CEU, Budapest.

Table of contents

• Installation
• Functions
• Use-case
• Website

Installation

xchangeR is not on CRAN yet, please install from GitHub:

remotes::install_github('szigony/xchangeR')

Functions

• eurusd
• Looks up the most recent USD/EUR exchange rate via an API call and returns the rate as a number.
• eurusds
• Looks up the daily USD/EUR exchange rate via an API call for the specified date range.
• Parameters:
  • date_from - The start of the range.
  • date_to - The end of the range.
  • last_x_days - Return the exchange rates for the last X days compared to date_to or today.
• convert_usd_to_eur
• Looks up the most recent USD/EUR exchange rate and computes the provided USD amount in EUR.
• Parameter:
  • usd_amount - The amount in USD to be converted to EUR.
• eur
• Converts a number to a string using the Euro sign, rounding up to 2 digits and using the comma as the separator.
• Parameter:
  • x - The number to be formatted as Euro.
• uneur
• Converts a string in Euro format to number.
• Parameter:
  • x - The string in Euro format to be transformed to number.

Use-case

A vignette demoing the usage of eurusds and eur with Bitcoin data from Binance is available here.

Website

A website showcasing the package's capabilities was created with pkgdown, and is available here.

szigony/xchangeR documentation built on June 7, 2019, 5:12 a.m.