rm_default: Remove/Replace/Extract Template

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

Remove/Replace/Extract Template

Description

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

Usage

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

ex_default(
  text.var,
  trim = !extract,
  clean = TRUE,
  pattern,
  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.
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.

See Also

rm_, 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_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

## Built in regex dictionary
rm_default("I live in Buffalo, NY 14217", pattern="@rm_city_state_zip")

## 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)

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