R/aux_funs.R

In IvanWilli/DemoKin: Estimate Population Kin Distribution

#' rename kin

#' @description Add kin labels depending the sex
#' @details See table `demokin_codes` to know label options.
#' @param df data.frame. A data frame with variable `kin` with `DemoKin` codes to be labelled.
#' @param sex character. "f" for female, "m" for male or "2sex" for both sex naming.
#' @return Add a column with kin labels in the input data frame.
#' @export
rename_kin <- function(df, sex = "f"){
  if(!"kin" %in% names(df)) stop("Input df needs a column named kin.")
  if(sex == "f") demokin_codes_sex <- DemoKin::demokin_codes[,c("DemoKin", "Labels_female")]
  if(sex == "m") demokin_codes_sex <- DemoKin::demokin_codes[,c("DemoKin", "Labels_male")]
  if(sex == "2sex") demokin_codes_sex <- DemoKin::demokin_codes[,c("DemoKin", "Labels_2sex")]
  colnames(demokin_codes_sex) <- c("kin", "kin_label")
  df %>%
    dplyr::left_join(demokin_codes_sex)
}