R/prune_02-A_oob.R

In FrankLef/eflMuncher: Data Pre-processing Tools Used by FL

#' Flag Rows Outside of a Given Numerical Range
#'
#' @inheritParams prune
#' @param rng The range of numerical values. The values outside of \code{rng}
#' will be identified with TRUE.
#'
#' @seealso prune_proc
#'
#' @return Logical vector where TRUE indicates values outside of \code{rng}.
#' @export
prune_oob_num <- function(data, cols, rng = c(-Inf, Inf)) {
  checkmate::assertDataFrame(data, min.rows = 1, min.cols = 1)
  checkmate::assertNames(cols, subset.of = names(data))
  checkmate::assertNumeric(rng, any.missing = FALSE, len = 2, sorted = TRUE)

  # verify the range
  assertthat::assert_that(diff(rng) > .Machine$double.eps^0.5)

  df <- data[, cols, drop = FALSE]  # must have drop = FALSE when only 1 column
  # test each column
  out <- apply(X = df, MARGIN = 2, FUN = function(x) {
    x < rng[1] | x > rng[2]
  })
  # find all rows where any value is TRUE
  sel <- apply(out, MARGIN = 1, FUN = function(x) {
    any(x)
  })
  sel
}


#' Flag Rows Outside of a Given Date Range
#'
#' @inheritParams prune
#' @param rng The range of date values. The values outside of \code{rng}
#' will be identified with TRUE.
#'
#' @seealso prune_proc
#'
#' @return Logical vector where TRUE indicates values outside of \code{rng}.
#' @export
prune_oob_date <- function(data, cols, rng = c(-Inf, Inf)) {
  checkmate::assertDataFrame(data, min.rows = 1, min.cols = 1)
  checkmate::assertNames(cols, subset.of = names(data))
  checkmate::assertDate(rng, any.missing = FALSE, len = 2)

  # verify the range
  # must convert multiply difftime by -1, does not work like diff()
  days_in_rng <- -difftime(rng[1], rng[2], units = "days")
  assertthat::assert_that(days_in_rng >= 1)

  df <- data[, cols, drop = FALSE]  # must have drop = FALSE when only 1 column

  # test each column
  out <- apply(X = df, MARGIN = 2, FUN = function(x) {
    x < rng[1] | x > rng[2]
  })
  # find all rows where any value is TRUE
  sel <- apply(out, MARGIN = 1, FUN = function(x) {
    any(x)
  })
  sel
}