# mpindex

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/mpindex)](https://cran.r-project.org/package=mpindex)
[![R-CMD-check](https://github.com/yng-me/mpindex/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/yng-me/mpindex/actions/workflows/R-CMD-check.yaml)
[![Coverage](https://codecov.io/gh/yng-me/mpindex/branch/main/graph/badge.svg)](https://app.codecov.io/github/yng-me/mpindex?branch=main)
<!-- badges: end -->

`mpindex` offers a set of easy-to-use functions for computing Multidimensional Poverty Index (MPI) using the Alkire-Foster (AF) counting method developed by Sabina Alkire and James Foster. Learn more in `vignette("mpindex")` and `?compute_mpi`.

## Installation

To install the `mpindex` package from CRAN:

```r
install.packages('mpindex')
```

If you want to get the latest development version of `mpindex`, install it from GitHub. Note that you may need to install `devtools`.

```r
# install.packages("devtools")
devtools::install_github('yng-me/mpindex')
```
## Usage

Load the package once you have successfully completed the installation.

```r
library(mpindex)
```
