Remove/Replace/Extract All Caps

Usage

rm_caps(text.var, trim = !extract, clean = TRUE, pattern = "@rm_caps", replacement = "", extract = FALSE, 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 uses the rm_caps 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" removed.

Description

Remove/replace/extract 'all caps' words containing 2 or more consecutive upper case letters from a string.

Examples

x <- c("UGGG! When I use caps I am YELLING!") rm_caps(x)
[1] "! When I use caps I am !"
rm_caps(x, replacement="\\L\\1")
[1] "uggg! When I use caps I am yelling!"
rm_caps(x, extract=TRUE)
[[1]] [1] "UGGG" "YELLING"