R/filter_text.R

In MarkMc1089/profanityfilter: Filter Text In dplyr Pipeline

#' @title Replace word prefixes that occur in given words.
#' @description Finds words starting with a word in a given list, and
#'   replaces each such word prefix with a given replacement.
#'
#' @param .data A data.frame or tibble.
#' @param .filters A list of words and/or regexes.
#' @param .replacement A character string used as replacement.
#' @param ... Columns to act upon.
#'
#' @return The original data, filtered.
#' @export
#'
#' @examples
#' data <- data.frame(
#'   x = c("This is some text...", "...containing words."),
#'   y = c("This is more text...", "...containing something."),
#'   z = c("This is some more text...", "...containing  more words.")
#' )
#'
#' data <- data %>%
#'   filter_text(
#'     c("some", "words"),
#'     "#",
#'     x, y
#'   )
#'
#' #                      x                        y                         z
#' # 1 This is #### text... This is more text...     This is some more text...
#' # 2 ...containing #####.  ...containing ####thing. ...containing more words.
filter_text <- function(.data, .filters, .replacement, ...) {
  .data %>% dplyr::mutate(
    dplyr::across(
      c(...),
      ~ stringr::str_replace_all(
        .,
        stringr::regex(
          paste0("\\b", .filters, collapse = "|\\b"),
          ignore_case = TRUE
        ),
        function(m) strrep(.replacement, nchar(m))
      )
    )
  )
}