Global Family Planning Estimation Model (FPEMglobal)

FPEMglobal is an R package for producing estimates and projections of contraceptive use and unmet need for family planning among married, unmarried, and all women.

This package was developed by the Family Planning Research (FPR) Group which is comprised of teams from the Alkema Lab at the University of Massachusetts, Amherst, the Population Division of the United Nations Dept. of Economic and Social Affairs, and Track20 at Avenir Health. It was supported, in part, by grants nos. OPP1110679 and OPP1183453, Making Family Planning Count, from the Bill & Melinda Gates Foundation. The package vignette has more information (vignette("FPEMglobal_Intro")).

The views expressed herein are those of the authors and do not necessarily reflect the views of the United Nations.

Installation

Ensure you have installed both R and JAGS. FPEMglobal has been tested with R v4.0.0 (64 bit) and JAGS v4.3.0.

Follow one of the following options:

Straight from GitHub

You will need to install the R package remotes. Then try

remotes::install_github("https://github.com/FPcounts/FPEMglobal", build_vignettes = TRUE, dependencies = TRUE)

From the .zip File (Windows Only)

Download the file "FPEMglobal_1.2.0.zip" from the release page (click "Assets" if it is not shown). To install, launch R and type:

install.packages("[path/to/FPEMglobal_1.2.0.zip]", repos = NULL)

You will need to enter the correct file path to the zip file. You will also need to install any package depencencies according to the notices that come up.

From Source

To install from source try

1. Clone the repository to your local drive.
2. Open a terminal or command prompt window in the directory containing the cloned repository.
3. Issue the following commands:

   R CMD build FPEMglobal
   R CMD INSTALL FPEMglobal_1.2.0.tar.gz
   

   If you are on Windows and you get an error after a line of output containing "i386" , try R CMD INSTALL --no-multiarch FPEMglobal_1.2.0.tar.gz. If that does not work follow the instructions above to install from the .zip file.

Vignette

The vignette "Introduction to FPEMglobal" explains the package and how to use it. From within R type:

vignette("FPEMglobal_Intro")