R/search_ssn.R

In DevikaNair90/prybar: Toolkit for Identifying Hidden PII in Text Data

#' Searches vector for emails.
#'
#' This function takes a vector input and searches presence of any text that 
#' appears to be an email.
#' 
#' The default output is a TRUE/FALSE vector but the function can also
#' return a dataframe of the original vector input, the TRUE/FALSE result, 
#' and the substring that matched the social security number pattern. 
#'
#' @param vec A vector input whose contents need to be searched for references
#' to SSNs.
#' @param output The desired output of function. Defaults to "vector" where T/F 
#' vector result is returned. The argument "dt" will output a table of original 
#' vector input, T/F vector result, and the matching substring. 
#' @import stringr
#' @import maditr
#' @suggest generator
#' @export
#' @examples
#' set.seed(2)
#' testcase <- data.frame(name = generator::r_full_names(2),  
#' ssn = generator::r_national_identification_numbers(2), 
#' dob = generator::r_date_of_births(2), 
#' email = generator::r_email_addresses(2), 
#' ip = generator::r_ipv4_addresses(2), 
#' phone = generator::r_phone_numbers(2),  
#' credit_card = generator::r_credit_card_numbers(2), 
#' lat = generator::r_latitudes(2), 
#' lon = generator::r_longitudes(2), 
#' stringsAsFactors = FALSE)
#' 
#' search_ssn(testcase$ssn)


search_ssn <- function(vec, output) {
  patt <- c("(?<![0-9])[0-9]{3}( |\\.|-)?[0-9]{2}( |\\.|-)?[0-9]{4}(?![0-9])")
  #patt <- paste(patt, collapse = "|")
  ssn <- maditr::data.table(OriginalString = vec,
                         SSNYN = stringr::str_detect(string = vec, pattern = patt), 
                         SSNString = stringr::str_extract_all(string = vec, pattern = patt))
  
  output <- ifelse(missing(output), "vector", output)
  
  if (output == "vector") {
    return(ssn$SSNYN)
  }
  
  else if (output == "dt") {
    return(ssn)
  }
  
  else {
    print("Output argument invalid.")
  }

}