qdapRegex (version 0.7.2)

rm_caps: Remove/Replace/Extract All Caps

Description

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

Usage

rm_caps(text.var, trim = !extract, clean = TRUE, pattern = "@rm_caps",
  replacement = "", extract = FALSE,
  dictionary = getOption("regex.library"), ...)
ex_caps(text.var, trim = !extract, clean = TRUE, pattern = "@rm_caps",
  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 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.

See Also

gsub, stri_extract_all_regex

Other rm_ functions: rm_abbreviation, rm_between, rm_bracket, rm_caps_phrase, 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

# NOT RUN {
x <- c("UGGG! When I use caps I am YELLING!")
rm_caps(x)
rm_caps(x, replacement="\\L\\1")
ex_caps(x)
# }