R/rename_sg_vars.R

In suddengains: Identify Sudden Gains in Longitudinal Data

#' Rename variable names to a generic and consistent format
#'
#' @description Rename variable names to a generic and consistent format that can be used by other functions of the suddengains package.
#'
#' @param data Dataframe in wide format.
#' @param rename_var_list Vector of variables to be renamed.
#' @param new_var_str String, new name for variables.
#' @param start_numbering Numeric, first number to be used as suffix for renaming variables specified in "rename_var_list".
#' @return Dataframe in wide format with renamed variables.

rename_sg_vars <- function(data, rename_var_list, new_var_str = "temp_var_", start_numbering = 1){

  if (start_numbering == 1) {
    for (i in base::seq_along(rename_var_list)) {
      base::names(data)[base::names(data) == rename_var_list[i]] <- base::paste0(new_var_str, i)
    }
  } else if (start_numbering == 0) {
    for (i in base::seq_along(rename_var_list)) {
      base::names(data)[base::names(data) == rename_var_list[i]] <- base::paste0(new_var_str, i - 1)
    }
  }

    # Return dataframe with renamed variables
    return(data)
}