Skip to content

Commit 03c7295

Browse files
gavinrozzigavinrozzi
committed
Update README
1 parent 79244c9 commit 03c7295

2 files changed

Lines changed: 94 additions & 68 deletions

File tree

‎README.Rmd‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ knitr::opts_chunk$set(
1111
fig.path = "man/figures/README-",
1212
out.width = "100%"
1313
)
14+
library(tibble)
1415
```
1516

1617
# zipcodeR <a href='https://gavinrozzi.github.io/zipcodeR/'><img src='man/figures/logo.png' align="right" height="139" /></a>
@@ -87,6 +88,17 @@ search_state('NJ')
8788
zip_distance('08901','08731')
8889
```
8990

91+
92+
### Calculate the distance between vectors of ZIP codes
93+
94+
```{r}
95+
zip_codes <- tribble(~zip_a, ~zip_b,
96+
"08731", "08901",
97+
"08734", "08005")
98+
99+
zip_distance(zip_codes$zip_a,zip_codes$zip_b)
100+
```
101+
90102
### Geocode a ZIP code to get its centroid
91103
```{r}
92104
geocode_zip('08901')

‎README.md‎

Lines changed: 82 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -78,23 +78,23 @@ library(zipcodeR)
7878

7979
``` r
8080
search_state('NJ')
81-
#> # A tibble: 732 x 24
81+
#> # A tibble: 732 × 24
8282
#> zipcode zipcode_type major_city post_office_city common_city_list county
83-
#> <chr> <chr> <chr> <chr> <list<raw>> <chr>
84-
#> 1 07001 Standard Avenel Avenel, NJ [18] Middlese…
85-
#> 2 07002 Standard Bayonne Bayonne, NJ [19] Hudson C…
86-
#> 3 07003 Standard Bloomfield Bloomfield, NJ [22] Essex Co…
87-
#> 4 07004 Standard Fairfield Fairfield, NJ [21] Essex Co…
88-
#> 5 07005 Standard Boonton Boonton, NJ [36] Morris C…
89-
#> 6 07006 Standard Caldwell Caldwell, NJ [39] Essex Co…
90-
#> 7 07007 PO Box Caldwell <NA> [30] Essex Co…
91-
#> 8 07008 Standard Carteret Carteret, NJ [20] Middlese…
92-
#> 9 07009 Standard Cedar Grove Cedar Grove, NJ [23] Essex Co…
93-
#> 10 07010 Standard Cliffside P… Cliffside Park,… [32] Bergen C…
83+
#> <chr> <chr> <chr> <chr> <blob> <chr>
84+
#> 1 07001 Standard Avenel Avenel, NJ <raw 18 B> Middlese…
85+
#> 2 07002 Standard Bayonne Bayonne, NJ <raw 19 B> Hudson C…
86+
#> 3 07003 Standard Bloomfield Bloomfield, NJ <raw 22 B> Essex Co…
87+
#> 4 07004 Standard Fairfield Fairfield, NJ <raw 21 B> Essex Co…
88+
#> 5 07005 Standard Boonton Boonton, NJ <raw 36 B> Morris C…
89+
#> 6 07006 Standard Caldwell Caldwell, NJ <raw 39 B> Essex Co…
90+
#> 7 07007 PO Box Caldwell <NA> <raw 30 B> Essex Co…
91+
#> 8 07008 Standard Carteret Carteret, NJ <raw 20 B> Middlese…
92+
#> 9 07009 Standard Cedar Grove Cedar Grove, NJ <raw 23 B> Essex Co…
93+
#> 10 07010 Standard Cliffside P… Cliffside Park,… <raw 32 B> Bergen C…
9494
#> # … with 722 more rows, and 18 more variables: state <chr>, lat <dbl>,
95-
#> # lng <dbl>, timezone <chr>, radius_in_miles <dbl>,
96-
#> # area_code_list <list<raw>>, population <int>, population_density <dbl>,
97-
#> # land_area_in_sqmi <dbl>, water_area_in_sqmi <dbl>, housing_units <int>,
95+
#> # lng <dbl>, timezone <chr>, radius_in_miles <dbl>, area_code_list <blob>,
96+
#> # population <int>, population_density <dbl>, land_area_in_sqmi <dbl>,
97+
#> # water_area_in_sqmi <dbl>, housing_units <int>,
9898
#> # occupied_housing_units <int>, median_home_value <int>,
9999
#> # median_household_income <int>, bounds_west <dbl>, bounds_east <dbl>,
100100
#> # bounds_north <dbl>, bounds_south <dbl>
@@ -104,14 +104,28 @@ search_state('NJ')
104104

105105
``` r
106106
zip_distance('08901','08731')
107-
#> [1] 40.7
107+
#> zipcode_a zipcode_b distance
108+
#> 1 08901 08731 40.7
109+
```
110+
111+
### Calculate the distance between vectors of ZIP codes
112+
113+
``` r
114+
zip_codes <- tribble(~zip_a, ~zip_b,
115+
"08731", "08901",
116+
"08734", "08005")
117+
118+
zip_distance(zip_codes$zip_a,zip_codes$zip_b)
119+
#> zipcode_a zipcode_b distance
120+
#> 1 08731 08901 6.9
121+
#> 2 08734 08005 45.1
108122
```
109123

110124
### Geocode a ZIP code to get its centroid
111125

112126
``` r
113127
geocode_zip('08901')
114-
#> # A tibble: 1 x 3
128+
#> # A tibble: 1 × 3
115129
#> zipcode lat lng
116130
#> <chr> <dbl> <dbl>
117131
#> 1 08901 40.5 -74.4
@@ -121,12 +135,12 @@ geocode_zip('08901')
121135

122136
``` r
123137
reverse_zipcode('08901')
124-
#> # A tibble: 1 x 24
138+
#> # A tibble: 1 × 24
125139
#> zipcode zipcode_type major_city post_office_city common_city_list county state
126-
#> <chr> <chr> <chr> <chr> <list<raw>> <chr> <chr>
127-
#> 1 08901 Standard New Bruns… New Brunswick, … [25] Middl… NJ
140+
#> <chr> <chr> <chr> <chr> <blob> <chr> <chr>
141+
#> 1 08901 Standard New Bruns… New Brunswick, … <raw 25 B> Middl… NJ
128142
#> # … with 17 more variables: lat <dbl>, lng <dbl>, timezone <chr>,
129-
#> # radius_in_miles <dbl>, area_code_list <list<raw>>, population <int>,
143+
#> # radius_in_miles <dbl>, area_code_list <blob>, population <int>,
130144
#> # population_density <dbl>, land_area_in_sqmi <dbl>,
131145
#> # water_area_in_sqmi <dbl>, housing_units <int>,
132146
#> # occupied_housing_units <int>, median_home_value <int>,
@@ -138,23 +152,23 @@ reverse_zipcode('08901')
138152

139153
``` r
140154
search_county('Ocean','NJ')
141-
#> # A tibble: 32 x 24
155+
#> # A tibble: 32 × 24
142156
#> zipcode zipcode_type major_city post_office_city common_city_list county
143-
#> <chr> <chr> <chr> <chr> <list<raw>> <chr>
144-
#> 1 08005 Standard Barnegat Barnegat, NJ [20] Ocean C…
145-
#> 2 08006 PO Box Barnegat Li… Barnegat Light, … [33] Ocean C…
146-
#> 3 08008 Standard Beach Haven Beach Haven, NJ [61] Ocean C…
147-
#> 4 08050 Standard Manahawkin Manahawkin, NJ [47] Ocean C…
148-
#> 5 08087 Standard Tuckerton Tuckerton, NJ [51] Ocean C…
149-
#> 6 08092 Standard West Creek West Creek, NJ [22] Ocean C…
150-
#> 7 08527 Standard Jackson Jackson, NJ [19] Ocean C…
151-
#> 8 08533 Standard New Egypt New Egypt, NJ [21] Ocean C…
152-
#> 9 08701 Standard Lakewood Lakewood, NJ [20] Ocean C…
153-
#> 10 08721 Standard Bayville Bayville, NJ [20] Ocean C…
157+
#> <chr> <chr> <chr> <chr> <blob> <chr>
158+
#> 1 08005 Standard Barnegat Barnegat, NJ <raw 20 B> Ocean C…
159+
#> 2 08006 PO Box Barnegat Li… Barnegat Light, … <raw 33 B> Ocean C…
160+
#> 3 08008 Standard Beach Haven Beach Haven, NJ <raw 61 B> Ocean C…
161+
#> 4 08050 Standard Manahawkin Manahawkin, NJ <raw 47 B> Ocean C…
162+
#> 5 08087 Standard Tuckerton Tuckerton, NJ <raw 51 B> Ocean C…
163+
#> 6 08092 Standard West Creek West Creek, NJ <raw 22 B> Ocean C…
164+
#> 7 08527 Standard Jackson Jackson, NJ <raw 19 B> Ocean C…
165+
#> 8 08533 Standard New Egypt New Egypt, NJ <raw 21 B> Ocean C…
166+
#> 9 08701 Standard Lakewood Lakewood, NJ <raw 20 B> Ocean C…
167+
#> 10 08721 Standard Bayville Bayville, NJ <raw 20 B> Ocean C…
154168
#> # … with 22 more rows, and 18 more variables: state <chr>, lat <dbl>,
155-
#> # lng <dbl>, timezone <chr>, radius_in_miles <dbl>,
156-
#> # area_code_list <list<raw>>, population <int>, population_density <dbl>,
157-
#> # land_area_in_sqmi <dbl>, water_area_in_sqmi <dbl>, housing_units <int>,
169+
#> # lng <dbl>, timezone <chr>, radius_in_miles <dbl>, area_code_list <blob>,
170+
#> # population <int>, population_density <dbl>, land_area_in_sqmi <dbl>,
171+
#> # water_area_in_sqmi <dbl>, housing_units <int>,
158172
#> # occupied_housing_units <int>, median_home_value <int>,
159173
#> # median_household_income <int>, bounds_west <dbl>, bounds_east <dbl>,
160174
#> # bounds_north <dbl>, bounds_south <dbl>
@@ -164,24 +178,24 @@ search_county('Ocean','NJ')
164178

165179
``` r
166180
search_city('Jersey City','NJ')
167-
#> # A tibble: 13 x 24
181+
#> # A tibble: 13 × 24
168182
#> zipcode zipcode_type major_city post_office_city common_city_list county
169-
#> <chr> <chr> <chr> <chr> <list<raw>> <chr>
170-
#> 1 07097 Unique Jersey City <NA> [23] Hudson Co…
171-
#> 2 07302 Standard Jersey City Jersey City, NJ [23] Hudson Co…
172-
#> 3 07303 PO Box Jersey City <NA> [23] Hudson Co…
173-
#> 4 07304 Standard Jersey City Jersey City, NJ [23] Hudson Co…
174-
#> 5 07305 Standard Jersey City Jersey City, NJ [23] Hudson Co…
175-
#> 6 07306 Standard Jersey City Jersey City, NJ [23] Hudson Co…
176-
#> 7 07307 Standard Jersey City Jersey City, NJ [23] Hudson Co…
177-
#> 8 07308 PO Box Jersey City <NA> [23] Hudson Co…
178-
#> 9 07309 Standard Jersey City <NA> [23] Hudson Co…
179-
#> 10 07310 Standard Jersey City Jersey City, NJ [23] Hudson Co…
180-
#> 11 07311 Standard Jersey City Jersey City, NJ [23] Hudson Co…
181-
#> 12 07395 Unique Jersey City <NA> [23] Hudson Co…
182-
#> 13 07399 Unique Jersey City <NA> [23] Hudson Co…
183+
#> <chr> <chr> <chr> <chr> <blob> <chr>
184+
#> 1 07097 Unique Jersey City <NA> <raw 23 B> Hudson Co…
185+
#> 2 07302 Standard Jersey City Jersey City, NJ <raw 23 B> Hudson Co…
186+
#> 3 07303 PO Box Jersey City <NA> <raw 23 B> Hudson Co…
187+
#> 4 07304 Standard Jersey City Jersey City, NJ <raw 23 B> Hudson Co…
188+
#> 5 07305 Standard Jersey City Jersey City, NJ <raw 23 B> Hudson Co…
189+
#> 6 07306 Standard Jersey City Jersey City, NJ <raw 23 B> Hudson Co…
190+
#> 7 07307 Standard Jersey City Jersey City, NJ <raw 23 B> Hudson Co…
191+
#> 8 07308 PO Box Jersey City <NA> <raw 23 B> Hudson Co…
192+
#> 9 07309 Standard Jersey City <NA> <raw 23 B> Hudson Co…
193+
#> 10 07310 Standard Jersey City Jersey City, NJ <raw 23 B> Hudson Co…
194+
#> 11 07311 Standard Jersey City Jersey City, NJ <raw 23 B> Hudson Co…
195+
#> 12 07395 Unique Jersey City <NA> <raw 23 B> Hudson Co…
196+
#> 13 07399 Unique Jersey City <NA> <raw 23 B> Hudson Co…
183197
#> # … with 18 more variables: state <chr>, lat <dbl>, lng <dbl>, timezone <chr>,
184-
#> # radius_in_miles <dbl>, area_code_list <list<raw>>, population <int>,
198+
#> # radius_in_miles <dbl>, area_code_list <blob>, population <int>,
185199
#> # population_density <dbl>, land_area_in_sqmi <dbl>,
186200
#> # water_area_in_sqmi <dbl>, housing_units <int>,
187201
#> # occupied_housing_units <int>, median_home_value <int>,
@@ -193,23 +207,23 @@ search_city('Jersey City','NJ')
193207

194208
``` r
195209
search_tz('Eastern')
196-
#> # A tibble: 14,025 x 24
210+
#> # A tibble: 14,025 × 24
197211
#> zipcode zipcode_type major_city post_office_city common_city_list county
198-
#> <chr> <chr> <chr> <chr> <list<raw>> <chr>
199-
#> 1 06001 Standard Avon Avon, CT [16] Hartford…
200-
#> 2 06002 Standard Bloomfield Bloomfield, CT [22] Hartford…
201-
#> 3 06010 Standard Bristol Bristol, CT [19] Hartford…
202-
#> 4 06013 Standard Burlington Burlington, CT [36] Hartford…
203-
#> 5 06016 Standard Broad Brook Broad Brook, CT [46] Hartford…
204-
#> 6 06018 Standard Canaan Canaan, CT [18] Litchfie…
205-
#> 7 06019 Standard Canton Canton, CT [34] Hartford…
206-
#> 8 06020 Standard Canton Cen… Canton Center, CT [25] Hartford…
207-
#> 9 06021 Standard Colebrook Colebrook, CT [21] Litchfie…
208-
#> 10 06022 Standard Collinsvil… Collinsville, CT [24] Hartford…
212+
#> <chr> <chr> <chr> <chr> <blob> <chr>
213+
#> 1 06001 Standard Avon Avon, CT <raw 16 B> Hartford…
214+
#> 2 06002 Standard Bloomfield Bloomfield, CT <raw 22 B> Hartford…
215+
#> 3 06010 Standard Bristol Bristol, CT <raw 19 B> Hartford…
216+
#> 4 06013 Standard Burlington Burlington, CT <raw 36 B> Hartford…
217+
#> 5 06016 Standard Broad Brook Broad Brook, CT <raw 46 B> Hartford…
218+
#> 6 06018 Standard Canaan Canaan, CT <raw 18 B> Litchfie…
219+
#> 7 06019 Standard Canton Canton, CT <raw 34 B> Hartford…
220+
#> 8 06020 Standard Canton Cen… Canton Center, CT <raw 25 B> Hartford…
221+
#> 9 06021 Standard Colebrook Colebrook, CT <raw 21 B> Litchfie…
222+
#> 10 06022 Standard Collinsvil… Collinsville, CT <raw 24 B> Hartford…
209223
#> # … with 14,015 more rows, and 18 more variables: state <chr>, lat <dbl>,
210-
#> # lng <dbl>, timezone <chr>, radius_in_miles <dbl>,
211-
#> # area_code_list <list<raw>>, population <int>, population_density <dbl>,
212-
#> # land_area_in_sqmi <dbl>, water_area_in_sqmi <dbl>, housing_units <int>,
224+
#> # lng <dbl>, timezone <chr>, radius_in_miles <dbl>, area_code_list <blob>,
225+
#> # population <int>, population_density <dbl>, land_area_in_sqmi <dbl>,
226+
#> # water_area_in_sqmi <dbl>, housing_units <int>,
213227
#> # occupied_housing_units <int>, median_home_value <int>,
214228
#> # median_household_income <int>, bounds_west <dbl>, bounds_east <dbl>,
215229
#> # bounds_north <dbl>, bounds_south <dbl>
@@ -219,7 +233,7 @@ search_tz('Eastern')
219233

220234
``` r
221235
get_tracts('08731')
222-
#> # A tibble: 6 x 3
236+
#> # A tibble: 6 × 3
223237
#> ZCTA5 TRACT GEOID
224238
#> <chr> <chr> <dbl>
225239
#> 1 08731 732001 34029732001

0 commit comments

Comments
 (0)