rm_email: Remove/Replace/Extract Email Addresses

In qdapRegex: Regular Expression Removal, Extraction, and Replacement Tools

Remove/Replace/Extract Email Addresses

Description

Remove/replace/extract email addresses from a string.

Usage

rm_email(
  text.var,
  trim = !extract,
  clean = TRUE,
  pattern = "@rm_email",
  replacement = "",
  extract = FALSE,
  dictionary = getOption("regex.library"),
  ...
)

ex_email(
  text.var,
  trim = !extract,
  clean = TRUE,
  pattern = "@rm_email",
  replacement = "",
  extract = TRUE,
  dictionary = getOption("regex.library"),
  ...
)

Arguments

text.var	The text variable.
trim	logical. If TRUE removes leading and trailing white spaces.
clean	trim logical. If TRUE extra white spaces and escaped character will be removed.
pattern	A character string containing a regular expression (or character string for fixed = TRUE) to be matched in the given character vector. Default, @rm_email uses the rm_email regex from the regular expression dictionary from the dictionary argument.
replacement	Replacement for matched pattern.
extract	logical. If TRUE the emails are extracted into a list of vectors.
dictionary	A dictionary of canned regular expressions to search within if pattern begins with "@rm_".
...	Other arguments passed to gsub.

Value

Returns a character string with email addresses removed.

Author(s)

Barry Rowlingson and Tyler Rinker <[e-mail]>.

References

The email regular expression was taken from: https://stackoverflow.com/a/25077704/1000343

See Also

gsub, stri_extract_all_regex

Other rm_ functions: rm_abbreviation(), rm_between(), rm_bracket(), rm_caps_phrase(), rm_caps(), rm_citation_tex(), rm_citation(), rm_city_state_zip(), rm_city_state(), rm_date(), rm_default(), rm_dollar(), rm_emoticon(), rm_endmark(), rm_hash(), rm_nchar_words(), rm_non_ascii(), rm_non_words(), rm_number(), rm_percent(), rm_phone(), rm_postal_code(), rm_repeated_characters(), rm_repeated_phrases(), rm_repeated_words(), rm_tag(), rm_time(), rm_title_name(), rm_url(), rm_white(), rm_zip()

Examples

x <- paste("fred is [e-mail] and joe is [e-mail] - but @this is a 
    twitter handle for [e-mail] or [e-mail]/[e-mail]")

x2 <- c("fred is [e-mail] and joe is [e-mail] - but @this is a", 
    "twitter handle for [e-mail] or [e-mail]/[e-mail]", 
    "hello world")

rm_email(x)
rm_email(x, replacement = '<a href="mailto:\\1" target="_blank">\\1</a>')
ex_email(x)
ex_email(x2)

qdapRegex documentation built on Oct. 17, 2023, 5:06 p.m.