R/swap_by_ids.R

In peterhurford/surveytools2: Surveytools2 is a collection of R functions that make working with dplyr on survey analysis just a little bit better. Inspired by dplyr and my previous surveytools package.

#' Renames values within a dataframe based on ids.
#' Useful for imputation.
#'
#' @param df data frame.  The data to be transformed.
#'
#' @param variable character. The name of the variable in df where the replacement occurs.
#'
#' @param swap_list list. A list mapping ids to the desired value for that id.
#' e.g., to replace the value for id #233 with "cat", use
#' \code{list('233' = 'cat')}
#'
#' @param idname character. The name of the column with ids.
#'
#' @export
swap_by_ids <- function(df, variable, swap_list, idname = 'id') {
  sapply(names(swap_list), function(id) {
    df[df[[idname]] == id, variable] <<- swap_list[[id]]
  })
  df
}