timriffe / migrar

R package for migration analysis

migraR

R package for migration analysis focused now on the Rogers and Castro multi exponential model and the estimation of the parameters using a simulation based on uniform a priori distributions for each parameter between 0 and 1, and 0 to 100 in the case of the location parameters corresponding to ages in the migration pattern.

This package was created on GitHub by J. Sebastian Ruiz-Santacruz and Jackson Garcés between February and June 2018. Cite as:

Ruiz-Santacruz and Garcés, 2018. migraR. Prototype package for adjusting Rogers and Castro models. Retrieved: dd/mm/yy

Description

The migraR package provides functions for estimate the parameters for Rogers and Castro Models: rc.7, rc.9, rc.11, rc.13 are created in the example using the Migramodel class. You may create your own multi-exponential model making profit of the function migramodel.

migraR functions

The migraR functions were conceived for estimate via linear optimization of the log(Migration Rate), the parameters of the Rogers and Castro models wit seven, eleven and thirteen parameters. Besides, the package gives the user the posibility to investigate wich curve fits better using the methodology provided in the IUSSP manual for the estimation of Rogers and Castro multi exponential model migration schedule with the same method for the optimization without constrains.

http://demographicestimation.iussp.org/content/multi-exponential-model-migration-schedule

Now, it is included the parametrization of the Coale and McNeil nuptiality curve, taken advantage of the class construction. You can use it setting the function parameter profile = "nuptial"

Package under continuous changes! place your bugs on the github tab issues :) 🚀

Getting Started

The package should be downloaded using devtools::install_github("elflacosebas/migraR"). Migration rates from Spain were calculated using the census 2011. The function best_migramod has the complete example. There are probably some bugs that we pledge you can report to us using issues in github.

Prerequisites

What things you need to install the software and how to install them

install.packages('devtools')
install.packages('dplyr')

Installing

Call the packages with library(dplyr) and library(devtools) then type install_github("elflacosebas/migraR")

###Example

The example was chosen selecting the migration data from Spanish Census 2011.

# Calling packages and dataset.

 library(migraR)
 library(dplyr)
 library(tidyverse)
 
 data("es_asmr")
 data1 <- es_asmr[-c(1,2),c(1,6)]
 colnames(data1) <- c("x","y")

 # Fitting and Plotting data
 fitted.val.7  <- best_migramod(dataIn = data1, maxite = 200, profile = "seven")
 fitted.val.9  <- best_migramod(dataIn = data1, maxite = 200, profile = "nine")
 fitted.val.11 <- best_migramod(dataIn = data1, maxite = 200, profile = "eleven")
 fitted.val.13 <- best_migramod(dataIn = data1, maxite = 200, profile = "thirteen")

 x11()
 plot(data1, cex=0.1, xlab = 'Age',
     ylab = 'Standardized Migration Rate')
 lines(data1[,1], fitted.val.7$modelClass$value(fitted.val.7$bestParam,data1), col="blue")
 lines(data1[,1], fitted.val.9$modelClass$value(fitted.val.9$bestParam,data1), col="orange")
 lines(data1[,1], fitted.val.11$modelClass$value(fitted.val.11$bestParam,data1), col="blue", lty=3)
 lines(data1[,1], fitted.val.13$modelClass$value(fitted.val.13$bestParam,data1), col="green")
 legend('topright', 
        legend = c(paste("(7)", "MAPE:", round(as.numeric(fitted.val.7$bestMAPE),2),
                         "R²:", round(as.numeric(fitted.val.7$bestRcuad),3)),
                   paste("(9)", "MAPE:", round(as.numeric(fitted.val.9$bestMAPE),2),
                         "R²:", round(as.numeric(fitted.val.9$bestRcuad),3)),
                   paste("(11)", "MAPE:", round(as.numeric(fitted.val.11$bestMAPE),2),
                        "R²:", round(as.numeric(fitted.val.11$bestRcuad),3)),
                   paste("(13)", "MAPE:", round(as.numeric(fitted.val.13$bestMAPE),2),
                         "R²:", round(as.numeric(fitted.val.13$bestRcuad),3))),
                  col = c("red",'orange',"blue","darkgreen"), lty = c(2,6,3,5))

Contributing

Please read DESCRIPTION.md for more details.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• J. Sebastian Ruiz-Santacruz - Initial Demographic and statistical work - PurpleBooth

• Jackson Garcés - Packaging work and statistical support - PurpleBooth

Acknowledgments

• to Joaquín Recaño Valverde (http://ced.uab.es/es/directori/joaquim-recano-valverde/), who inspires this work.