R: Remove/Replace/Extract All Caps Phrases

rm_caps_phrase {qdapRegex}

R Documentation

Remove/Replace/Extract All Caps Phrases

Description

Remove/replace/extract 'all caps' phrases containing 1 or more consecutive upper case letters from a string. If one word phrase the word must be 3+ letters long.

Usage

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

ex_caps_phrase(
  text.var,
  trim = !extract,
  clean = TRUE,
  pattern = "@rm_caps_phrase",
  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_caps_phrae` uses the `rm_caps_phrase` regex from the regular expression dictionary from the `dictionary` argument.
`replacement`	Replacement for matched `pattern`.
`extract`	logical. If `TRUE` the all caps strings 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 "all caps phrases" removed.

Other rm_ functions: rm_abbreviation(), rm_between(), rm_bracket(), rm_caps(), rm_citation_tex(), rm_citation(), rm_city_state_zip(), rm_city_state(), rm_date(), rm_default(), rm_dollar(), rm_email(), 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 <- c("UGGG! When I use caps I am YELLING!",
   "Or it may mean this is VERY IMPORTANT!",
   "or trying to make a LITTLE SEEM like IT ISN'T LITTLE"
)
rm_caps_phrase(x)
ex_caps_phrase(x)