R/append_process_cols.R

In nelsonroque/ruf: An R Package of Random, but Useful Functions (RUF)

#' RM2C2dev
#' @name append_process_cols
#' @export
#' @param data class: data.frame
#' @param algo class: string
#' @import tidyverse
#' @import digest
#' @examples
#' append_process_cols(data, algo='md5')
append_process_cols <- function(data, algo="md5") {
  #' parameter validation
  #' verify data passed in is data.frame or tibble
  if(is_data_frame_tibble(data)) {
    
    #' generate MD5 checksum of `data`
    data_md5 <- digest::digest(data, algo=algo)
    
    #' append MD5 checksum and file processing timestamp to `data`
    data_stamped <- data %>% 
      mutate(m2c2_processing_hash = data_md5) %>%
      mutate(m2c2_processing_timestamp = format(Sys.time(), "%Y-%m-%d %H:%M:%S"))
    
    #' add package version
    
  } else {
    
    #' if data is valid, stop code execution and present an error message
    stop("`data` is not a data.frame or tibble. Please try again.")
  }
  
  return(data_stamped)
}