R/extract_string.R

Defines functions extract_string

#' Extract any string from a vector using a regular expression
#'
#'
#' This function can be used to extract any string from a
#' vector by providing a regular expression pattern
#'
#'
#' @author Thibaut Jombart \email{thibautjombart@@gmail.com}
#'
#'
#' @param x a vector containing a string
#'
#'
#' @param pattern a regular expression pattern to be matched
#'
#' @noRd
#' @keywords internal
#'
#' @examples
#'
#' \dontrun{
#' x <- "I love RECON"
#' pattern <- "[A-Z]{5}"
#'
#' check <- extract_string(x, pattern)
#' print(check)
#' }
#'

extract_string <- function(x, pattern) {
  extract_string_atomic <- function(x) {
    m <- regexpr(pattern, x)
    out <- regmatches(x, m)
    if (!length(out)) {
      out <- NA_character_
    }
    out
  }
  vapply(x, extract_string_atomic, character(1))
}
reconhub/rfextras documentation built on Aug. 16, 2021, 5:25 a.m.