Remove/Replace/Extract Zip Codes

Share:

Description

Remove/replace/extract zip codes from a string.

Usage

1
2
3
4
5
6
7
rm_zip(text.var, trim = !extract, clean = TRUE, pattern = "@rm_zip",
  replacement = "", extract = FALSE,
  dictionary = getOption("regex.library"), ...)

ex_zip(text.var, trim = !extract, clean = TRUE, pattern = "@rm_zip",
  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_zip uses the rm_zip regex from the regular expression dictionary from the dictionary argument.

replacement

Replacement for matched pattern.

extract

logical. If TRUE the zip codes 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 U.S. 5 and 5+4 zip codes removed.

Author(s)

stackoverflow's hwnd and Tyler Rinker <tyler.rinker@gmail.com>.

References

The time regular expression was taken from: http://stackoverflow.com/a/25223890/1000343

See Also

gsub, stri_extract_all_regex

Other rm_.functions: as_numeric, as_numeric2, ex_number, rm_number; as_time, as_time2, ex_time, ex_transcript_time, rm_time, rm_transcript_time; ex_abbreviation, rm_abbreviation; ex_angle, ex_bracket, ex_bracket_multiple, ex_curly, ex_round, ex_square, rm_angle, rm_bracket, rm_bracket_multiple, rm_curly, rm_round, rm_square; ex_between, ex_between_multiple, rm_between, rm_between_multiple; ex_caps_phrase, rm_caps_phrase; ex_caps, rm_caps; ex_citation_tex, rm_citation_tex; ex_citation, rm_citation; ex_city_state_zip, rm_city_state_zip; ex_city_state, rm_city_state; ex_date, rm_date; ex_default, rm_default; ex_dollar, rm_dollar; ex_email, rm_email; ex_emoticon, rm_emoticon; ex_endmark, rm_endmark; ex_hash, rm_hash; ex_nchar_words, rm_nchar_words; ex_non_ascii, rm_non_ascii; ex_non_words, rm_non_words; ex_percent, rm_percent; ex_phone, rm_phone; ex_postal_code, rm_postal_code; ex_repeated_characters, rm_repeated_characters; ex_repeated_phrases, rm_repeated_phrases; ex_repeated_words, rm_repeated_words; ex_tag, rm_tag; ex_title_name, rm_title_name; ex_twitter_url, ex_url, rm_twitter_url, rm_url; ex_white, ex_white_bracket, ex_white_colon, ex_white_comma, ex_white_endmark, ex_white_lead, ex_white_lead_trail, ex_white_multiple, ex_white_punctuation, ex_white_trail, rm_white, rm_white_bracket, rm_white_colon, rm_white_comma, rm_white_endmark, rm_white_lead, rm_white_lead_trail, rm_white_multiple, rm_white_punctuation, rm_white_trail

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
x <- c("Mr. Bean bought 2 tickets 2-613-213-4567",
  "43 Butter Rd, Brossard QC K0A 3P0 - 613 213 4567",
  "Rat Race, XX, 12345",
  "Ignore phone numbers(613)2134567",
  "Grab zips with dashes 12345-6789 or no space before12345-6789",
  "Grab zips with spaces 12345 6789 or no space before12345 6789",
  "I like 1234567 dogs"
)

rm_zip(x)
ex_zip(x)

## ======================= ##
## BUILD YOUR OWN FUNCTION ##
## ======================= ##

## example from: http://stackoverflow.com/a/26092576/1000343
zips <- data.frame(id = seq(1, 6),
    address = c("Company, 18540 Main Ave., City, ST 12345",
    "Company 18540 Main Ave. City ST 12345-0000",
    "Company 18540 Main Ave. City State 12345",
    "Company, 18540 Main Ave., City, ST 12345 USA",
    "Company, One Main Ave Suite 18540m, City, ST 12345",
    "company 12345678")
)

## Function to grab even if a character follows the zip

# paste together a more flexible regular expression
pat <- pastex(
    "@rm_zip",
    "(?<!\\d)\\d{5}(?!\\d)",
    "(?<!\\d)\\d{5}-\\d{4}(?!\\d)"
)
# Create your own function that extract is set to TRUE
ex_zip2 <- rm_(pattern=pat, extract=TRUE)
ex_zip2(zips$address)

## Function to extract just 5 digit zips

ex_zip3 <- rm_(pattern="(?<!\\d)\\d{5}(?!\\d)", extract=TRUE)
ex_zip3(zips$address)

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.