diff --git a/DESCRIPTION b/DESCRIPTION index 7edcaab..4ab5510 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: censusxy Title: Access the U.S. Census Bureau Geocoder -Version: 0.1.0.9000 +Version: 0.1.0 Authors@R: c( person("Christopher", "Prener", ,"chris.prener@slu.edu", c("aut", "cre"), comment = c(ORCID = "0000-0002-4310-9888")), diff --git a/NEWS.md b/NEWS.md index 0e982b9..bc12683 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# censusxy 0.1.0.9000 +# censusxy 0.1.0 * Added a `NEWS.md` file to track changes to the package. * Add initial package infrastructure and functionality. diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html index 439b129..8375055 100644 --- a/docs/CODE_OF_CONDUCT.html +++ b/docs/CODE_OF_CONDUCT.html @@ -63,7 +63,7 @@ censusxy - 0.1.0.9000 + 0.1.0 diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html index 609b2a4..47875ac 100644 --- a/docs/CONTRIBUTING.html +++ b/docs/CONTRIBUTING.html @@ -63,7 +63,7 @@ censusxy - 0.1.0.9000 + 0.1.0 diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 672a4b4..8d6ec30 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -63,7 +63,7 @@ censusxy - 0.1.0.9000 + 0.1.0 diff --git a/docs/PULL_REQUEST_TEMPLATE.html b/docs/PULL_REQUEST_TEMPLATE.html index ed5ecf4..68181fa 100644 --- a/docs/PULL_REQUEST_TEMPLATE.html +++ b/docs/PULL_REQUEST_TEMPLATE.html @@ -63,7 +63,7 @@ censusxy - 0.1.0.9000 + 0.1.0 diff --git a/docs/articles/censusxy.html b/docs/articles/censusxy.html index eeeff0a..7cb30b2 100644 --- a/docs/articles/censusxy.html +++ b/docs/articles/censusxy.html @@ -31,7 +31,7 @@ censusxy - 0.1.0.9000 + 0.1.0 @@ -126,12 +126,12 @@

Usage

-

This package contains a single exported function, cxy_geocode(). The only required arguments are .data for the data.frame or tibble containing address data, and address specifying the column name containing street addresses. The function supports non-standard evaluation, meaning you do not need to quote arguments for column names.

-
results <- cxy_geocode(stl_homicides, address = street_address)
+

This package contains a single exported function, cxy_geocode(). The only required arguments are .data for the data.frame or tibble containing address data, and address specifying the column name containing street addresses. The function supports non-standard evaluation, meaning you do not need to quote arguments for column names.

+
results <- cxy_geocode(stl_homicides, address = street_address)

However, it is highly recommended that you include city, state and zip code as well. Doing so will increase speed and accuracy significantly. The homicide deta contain city and state data as well, so the preferred call for these data would be:

-
results <- cxy_geocode(stl_homicides, address = street_address, city = city, state = state)
+
results <- cxy_geocode(stl_homicides, address = street_address, city = city, state = state)

Finally, two output types are supported. By default, a tibble is returned (output = "tibble") with a minimal set of variables that describe the accuracy of a given observation’s geocoding (style = "minimal"). A complete set of values returned by the API for each observation can be obtained by using style = "full". Alternatively, an sf object can be returned with the geocoded data projected using the WGS 1984 geographic coordinate system:

-
homicide_sf <- cxy_geocode(stl_homicides, id, street_address, city, state, postal_code, output = "sf")
+
homicide_sf <- cxy_geocode(stl_homicides, id, street_address, city, state, postal_code, output = "sf")

Note, however, that it returns only matched addresses, including those approximated by street length. If there are unmatched addresses, they will be dropped from the output. Use output = "tibble" to return all addresses, including those that are unmatched.

Output returned as an sf object can be previewed with a package like mapview:

> mapview::mapview(homicide_sf)
diff --git a/docs/articles/index.html b/docs/articles/index.html index b10bfe0..fdaa324 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -63,7 +63,7 @@ censusxy - 0.1.0.9000 + 0.1.0
diff --git a/docs/authors.html b/docs/authors.html index f6fc4ca..f994fd3 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -63,7 +63,7 @@ censusxy - 0.1.0.9000 + 0.1.0 diff --git a/docs/index.html b/docs/index.html index 8548f74..cf45125 100644 --- a/docs/index.html +++ b/docs/index.html @@ -37,7 +37,7 @@ censusxy - 0.1.0.9000 + 0.1.0 diff --git a/docs/news/index.html b/docs/news/index.html index 58f768c..28d7149 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -63,7 +63,7 @@ censusxy - 0.1.0.9000 + 0.1.0 @@ -109,9 +109,9 @@

Changelog

Source: NEWS.md -
+

-censusxy 0.1.0.9000

+censusxy 0.1.0
diff --git a/docs/reference/cxy_geocode.html b/docs/reference/cxy_geocode.html index 1010e37..6622d25 100644 --- a/docs/reference/cxy_geocode.html +++ b/docs/reference/cxy_geocode.html @@ -69,7 +69,7 @@ censusxy - 0.1.0.9000 + 0.1.0
diff --git a/docs/reference/index.html b/docs/reference/index.html index 39688da..9ff648d 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -63,7 +63,7 @@ censusxy - 0.1.0.9000 + 0.1.0 diff --git a/docs/reference/stl_homicides.html b/docs/reference/stl_homicides.html index 6f362ec..b289230 100644 --- a/docs/reference/stl_homicides.html +++ b/docs/reference/stl_homicides.html @@ -65,7 +65,7 @@ censusxy - 0.1.0.9000 + 0.1.0 diff --git a/docs/reference/stl_homicides_small.html b/docs/reference/stl_homicides_small.html index 2c7afdb..7eb1f56 100644 --- a/docs/reference/stl_homicides_small.html +++ b/docs/reference/stl_homicides_small.html @@ -65,7 +65,7 @@ censusxy - 0.1.0.9000 + 0.1.0