R/meta_rename.R

In Lingtax/Qualtrics: A package for making misinformation lab members less angry.

#' Replaces names by reference to a metadata dataframe
#'
#' `meta_rename` allows fast replacement of variable names by key-value pairing with a metadata file.
#'
#' @param df A data.frame object for renaming.
#' @param metadata A data.frame object containing the key-value pair
#' @param old An unquoted string of the key column name in the metadata object
#' @param new An unquoted string of the value column name in the metadata object
#'
#' @return `data.frame` object with new names as per key-value pairs.
#' @export
#'
#' @examples
#'
#' meta <- meta
#' df <- test_data
#' df <- meta_rename(df, metadata = meta, old = name_raw, new = name_clean)
#'
meta_rename <-  function(df, metadata, old, new) {

  keys   <- metadata[[deparse(substitute(old))]]
  values <- metadata[[deparse(substitute(new))]]

  matchlist <- setNames(values, keys)
  names(df) <- matchlist[names(df)]
  return(df)

  }