R/fn_rename.R

In ready4-dev/specific: Specify Models to Solve Inverse Problems

#' Rename from named vector
#' @description rename_from_nmd_vec() is a Rename function that renames elements of an object based on a pre-speccified schema. Specifically, this function implements an algorithm to rename from named vector. The function returns Renamed data (a tibble).
#' @param data_tb Data (a tibble)
#' @param nmd_vec_chr Named vector (a character vector)
#' @param vec_nms_as_new_1L_lgl Vector names as new (a logical vector of length one), Default: T
#' @return Renamed data (a tibble)
#' @rdname rename_from_nmd_vec
#' @export 
#' @importFrom purrr reduce
#' @importFrom dplyr rename
#' @importFrom rlang sym
#' @keywords internal
rename_from_nmd_vec <- function (data_tb, nmd_vec_chr, vec_nms_as_new_1L_lgl = T) 
{
    if (vec_nms_as_new_1L_lgl) {
        renamed_data_tb <- purrr::reduce(1:length(nmd_vec_chr), 
            .init = data_tb, ~dplyr::rename(.x, `:=`(!!rlang::sym(names(nmd_vec_chr)[.y]), 
                nmd_vec_chr[.y] %>% as.vector())))
    }
    else {
        renamed_data_tb <- purrr::reduce(1:length(nmd_vec_chr), 
            .init = data_tb, ~dplyr::rename(.x, `:=`(!!rlang::sym(nmd_vec_chr[.y]), 
                names(nmd_vec_chr)[.y] %>% as.vector())))
    }
    return(renamed_data_tb)
}