Remove/Replace/Extract Template

Usage

rm_default(text.var, trim = !extract, clean = TRUE, pattern, 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.
replacement
Replacement for matched pattern.
extract
logical. If TRUE the 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 substring removed.

Description

Remove/replace/extract substring from a string. This is the template used by other qdapRegex rm_XXX functions.

Examples

## Built in regex dictionary rm_default("I live in Buffalo, NY 14217", pattern="@rm_city_state_zip")
[1] "I live in"
## User defined regular expression pat <- "(\\s*([A-Z][\\w-]*)+),\\s([A-Z]{2})\\s(?<!\\d)\\d{5}(?:[ -]\\d{4})?\\b" rm_default("I live in Buffalo, NY 14217", pattern=pat)
[1] "I live in"