R/any_grepl.R

In hutils: Miscellaneous R Functions and Aliases

#' Does the pattern appear anywhere?
#' @description Shortcut for \code{any(grepl(...))}, mostly for consistency.
#' @param x A character vector.
#' @param pattern,perl,ignore.case,fixed As in \code{\link[base]{grep}}. 
#' @param quiet (logical, default: \code{FALSE}) If \code{TRUE}, silences any messages.
#' 
#' @details From version \code{v 1.4.0}, \code{any_grepl(a, bb)} will be internally
#' reversed to \code{any_grepl(bb, a)} if \code{length(bb) > 1} and \code{length(a) == 1}.
#' 
#' @examples
#' any_grepl(c("A_D_E", "K0j"), "[a-z]")
#' 
#' @export any_grepl
#' 

any_grepl <- function(x,
                      pattern,
                      perl = TRUE,
                      ignore.case = FALSE,
                      fixed = FALSE, 
                      quiet = FALSE) {
  if (length(x) == 1L && length(pattern) > 1L) {
    message("Reversing any_grepl")
    return(any_grepl(x = pattern, pattern = x, perl, ignore.case, fixed, quiet))
  }
  
  if (fixed && ignore.case) {
    if (!quiet) {
      message("`fixed` and `ignore.case` both TRUE, ",
              "so considering both upper and lowercase ",
              "versions of pattern with fixed = TRUE.")
    }
    # For convenience
    return(any_grepl(tolower(x),
                     pattern = tolower(pattern), 
                     perl = FALSE,
                     ignore.case = FALSE,
                     fixed = TRUE))
  }
  
  if (missing(perl) && fixed) {
    perl <- FALSE
  }
  
  as.logical(length(grep(pattern = pattern,
                         x = x,
                         perl = perl,
                         fixed = fixed,
                         ignore.case = ignore.case)))
  
}