Obtain Coefficients from Scaled SVD of HIMD Data

Obtain time series of coefficients from a scaled SVD of data from the Human Internal Migration Database. The coefficients are a scaled version of the \(U\) matrix from the SVD.

Usage

coef_himd(
  zipfile,
  time_interval = 1,
  measure_type = c("rate", "prob"),
  n_comp = 5,
  eps = 1e-05
)

Arguments

zipfile: The name of a zipped file downloaded from the Human Internal Migration Database. A path name that is handled by utils::unzip().
time_interval: Length of interval over which values are calculated. Choices are 1 or 5. Default is 1.
measure_type: "prob" or "rate". Whether values are to be treated as probabilities or as rates. See data_ssvd_himd() for details. Default is "rate".
n_comp: Number of SVD components to include in result. Default is 5.
eps: Parameter for truncating probabililities or rates. Default is 0.00001.

Value

A tibble

Truncation and transformation

If measure_type is "prob", then reported probabilities outside (eps, 1-eps) are shifted to eps or 1-eps, and all values are logit-transformed, before the SVD is applied.

If measure_type is "rate", then reported probabilities less than eps are shifted to eps, and all values are log-transformed, before the SVD is applied.

Examples