R/todo/makeNA.R

Defines functions makeNA

#' Make NA
#'
#' Examine a dataset for numeric values outside of a desired range.
#' Bad values will be replaced with NAs.
#'
#' \code{mins} and \code{maxs} should be named vectors, where the names
#' are columns found in \code{data}. They should contain the same names
#' and have the same length.
#'
#' @param data data.frame. Dataset with numerical values to range check.
#' @param mins named numeric vector. Minimum value for each named column.
#' @param maxs named numeric vector. Maximum value for each named column.
#' @return Returns modified data.frame invisibly.
#' @export
#' @examples
#' set.seed(100)
#' df <- data.frame(x=rnorm(100), y=rnorm(100, sd=0.5))
#' na.df <- makeNA(df, c(x=-2,y=-1), c(x=2,y=1))

makeNA <- function(data, mins, maxs) {

  # Make sure length(mins) = length(maxs)
  if(length(mins) != length(maxs)) stop('Min and max not specified for every variable')

  # If length(mins) = length(maxs), make sure names(mins) = names(maxs)
  if(any(sort(names(mins)) != sort(names(maxs)))) {
    stop(paste('Variable names specified in', sQuote('mins'), 
      'and', sQuote('maxs'), 'do not match'))
  }

  # Make sure valid column names were specified in mins and maxs for the data frame data
  if(any(names(mins) %nin% names(data))) {
    stop(paste('Illegal variable names specified in',
      sQuote('mins'), 'and', sQuote('maxs')))
  }

  n <- names(mins)
  for(i in 1:length(n)) {
    x     <- data[[n[i]]]
    check <- paste('datta <', mins[i], '| datta >', maxs[i])
    checkfn <- eval(parse(text = paste('function(datta) {', check, '}')))
    bad <- checkfn(x)
    nbad <- sum(bad, na.rm = TRUE)
    if(nbad) {
      data[bad & !is.na(x), n[i]] <- NA
    }
  }
  invisible(data)
}
harrelfe/greport documentation built on Feb. 17, 2018, 11:41 p.m.