R/badvalue_restore.R

In sachserf/badval: Reproducible data manipulation

#' Restore bad values
#'
#' @description This function will backup the specified bad values of a data
#'   frame.
#' @param goodstring Character. Name of a column that should be restored.
#' @param backup_data A data frame containing only bad values and NA.
#' @param cleaned_data A data frame containing data without bad values
#' @return data frame
#' @note The Index will compare and use row.names of both datasets to restore
#'   the values. Therefore you should not use the function if you manually
#'   changed the row names of the cleaned data after creating the backup data.
#' @author Frederik Sachser
#' @seealso \code{\link{badvalue_backup}}
#' @export

badvalue_restore <- function(goodstring,
                             backup_data,
                             cleaned_data) {
  backup_data <- as.data.frame(backup_data)
  cleaned_data <- as.data.frame(cleaned_data)
  if (any(is.na(backup_data[goodstring]) == FALSE) == TRUE) {
    vec <- which(is.na(backup_data[goodstring]) == FALSE)
    ID_backup <- row.names(backup_data[vec,])
    ID_cleaned <-
      grep(pattern = paste(ID_backup, collapse = "|"),
           x = row.names(cleaned_data))
    ID_cleaned <- row.names(cleaned_data)[ID_cleaned]
    ID_missing <- ID_backup[!ID_backup %in% ID_cleaned]
    ID_backup <- ID_backup[ID_backup %in% ID_cleaned]
    cleaned_data[grep(pattern = paste(ID_cleaned, collapse = "|"),
                      x = row.names(cleaned_data)), goodstring] <-
      backup_data[grep(pattern = paste(ID_backup, collapse = "|"),
                       x = row.names(backup_data)), goodstring]
  }
  if (length(ID_missing > 0)) {
    cat("The following rows are missing: ",
        paste(ID_missing, collapse = ", "))
  }
  return(cleaned_data)
}