README.Rmd

---
output: github_document
---

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

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

# pacta.multi.loanbook.analysis

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check](https://github.com/RMI-PACTA/pacta.multi.loanbook.analysis/actions/workflows/R.yml/badge.svg)](https://github.com/RMI-PACTA/pacta.multi.loanbook.analysis/actions/workflows/R.yml)
[![Codecov test coverage](https://codecov.io/gh/RMI-PACTA/pacta.multi.loanbook.analysis/branch/main/graph/badge.svg)](https://app.codecov.io/gh/RMI-PACTA/pacta.multi.loanbook.analysis?branch=main)
<!-- badges: end -->

This repository hosts all R functions needed to calculate aggregate alignment
metrics for loan books. It also provides plotting functions that help identify
patterns within a large set of loan books.

As such these functions are especially useful to assess financial sector level
comparison of multiple financial institutions. However, its use is not
restricted to that level and input loan books can be (dis)aggregated to any
level relevant to the analysis.

All third party data must be input by the user and is not part of this
repository. The repository contains some sample data sets that can be used for
testing purposes.