index_distance: Summary indices of migration distance
In migest: Methods for the Indirect Estimation of Bilateral Migration

index_distance

R Documentation

Summary indices of migration distance

Description

Summary indices of migration distance

Usage

index_distance(
  m = NULL,
  d = NULL,
  orig_col = "orig",
  dest_col = "dest",
  flow_col = "flow",
  dist_col = "dist",
  long = TRUE
)

Arguments

`m`	A `matrix` or data frame of origin-destination flows. For `matrix` the first and second dimensions correspond to origin and destination respectively. For a data frame ensure the correct column names are passed to `orig_col`, `dest_col` and `flow_col`.
`d`	A `matrix` or data frame of origin-destination distances. For `matrix` the first and second dimensions correspond to origin and destination respectively. For a data frame ensure the correct column names are passed to `orig_col`, `dest_col` and `dist_col`. Region names should match those in `m`.
`orig_col`	Character string of the origin column name (when `m` is a data frame rather than a `matrix`)
`dest_col`	Character string of the destination column name (when `m` is a data frame rather than a `matrix`)
`flow_col`	Character string of the flow column name (when `m` is a data frame rather than a `matrix`)
`dist_col`	Character string of the distance column name (when `dist` is a data frame rather than a `matrix`)
`long`	Logical to return a long data frame with index values all in one column

Value

A tibble with 3 summary measures where

`mean`	Mean migration distance from Bell et. al. (2002) - not discussed in text but given in Table 6
`median`	Mean migration distance from Bell et. al. (2002)
`decay`	Distance decay parameter obtained from a Poisson regression model (`flow ~ orig + dest + log(dist)`)

Source

Bell, M., Blake, M., Boyle, P., Duke-Williams, O., Rees, P. H., Stillwell, J., & Hugo, G. J. (2002). Cross-national comparison of internal migration: issues and measures. Journal of the Royal Statistical Society: Series A (Statistics in Society), 165(3), 435–464. https://doi.org/10.1111/1467-985X.00247

Examples

# single year
index_distance(
  m = subset(korea_gravity, year == 2020),
  d = subset(korea_gravity, year == 2020),
  dist_col = "dist_cent"
)

# multiple years
library(dplyr)
library(tidyr)
library(purrr)

korea_gravity %>%
  select(year, orig, dest, flow, dist_cent) %>%
  group_nest(year) %>%
  mutate(i = map2(
    .x = data, .y = data, 
    .f = ~index_distance(m = .x, d = .y, dist_col = "dist_cent", long = FALSE)
  )) %>%
  select(-data) %>%
  unnest(i)

migest documentation built on Nov. 18, 2023, 9:06 a.m.