README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# bnmr

<img src="man/figures/logo.png" width=120 height=139 align="right" /></img>

<!-- badges: start -->
[![codecov](https://codecov.io/gh/philip-khor/bnmr/branch/main/graph/badge.svg?token=4Z9KFCZpGa)](https://codecov.io/gh/philip-khor/bnmr)
[![R-CMD-check](https://github.com/philip-khor/bnmr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/philip-khor/bnmr/actions/workflows/R-CMD-check.yaml)
[![pages-build-deployment](https://github.com/philip-khor/bnmr/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/philip-khor/bnmr/actions/workflows/pages/pages-build-deployment)
[![test-coverage](https://github.com/philip-khor/bnmr/actions/workflows/test-coverage-pak.yaml/badge.svg)](https://github.com/philip-khor/bnmr/actions/workflows/test-coverage-pak.yaml)

<!-- badges: end -->
  
The goal of **bnmr** is to provide a set of convenient wrapper functions for the Central Bank of Malaysia's API. 


## Installation


To install **bnmr**, run the following code (requires remotes):

```{r, eval = FALSE}
# install.packages("remotes")
remotes::install_github("philip-khor/bnmr")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r, message = FALSE}
library(bnmr)
get_base_rate()
```

## License 

This project is licensed under the terms of the MIT license.