Skip to content

Commit

Permalink
update-readme
Browse files Browse the repository at this point in the history
rephrased geocoder services section
  • Loading branch information
jessecambon committed Jul 14, 2020
1 parent 54fdf33 commit aa1322d
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 25 deletions.
6 changes: 3 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ options(tibble.print_min = 5, tibble.print_max = 5)

## Introduction

Tidygeocoder makes getting data from geocoding services easy. The currently supported services are the [US Census geocoder](https://geocoding.geo.census.gov/), [Nominatim (OSM)](https://nominatim.org), [Geocodio](https://www.geocod.io/), and [Location IQ](https://locationiq.com/). In addition to the usage example below, you can find a blog post on geocoding landmarks in Washington, DC [here](https://jessecambon.github.io/2019/11/11/tidygeocoder-demo.html).
Tidygeocoder makes getting data from geocoder services easy. In addition to the usage example below, you can find a blog post on geocoding landmarks in Washington, DC [here](https://jessecambon.github.io/2019/11/11/tidygeocoder-demo.html).

All results are returned in [tibble format](https://tibble.tidyverse.org/). Batch geocoding (geocoding multiple addresses per query) is used by default for the US Census and Geocodio services when multiple addresses are provided. Duplicate, missing/NA, and blank address data is handled elegantly - only unique addresses are passed to geocoder services, but the rows in the original data are preserved.

## Geocoder Services

The Census geocoder is restricted to street-level addresses in the United States, Geocodio covers the U.S. and Canada, while Location IQ and OSM have worldwide coverage. The Census and OSM services support batch geocoding while Location IQ and OSM do not.
The currently supported services are the [US Census geocoder](https://geocoding.geo.census.gov/), [Nominatim (OSM)](https://nominatim.org), [Geocodio](https://www.geocod.io/), and [Location IQ](https://locationiq.com/). The Census geocoder is restricted to street-level addresses in the United States, Geocodio covers the U.S. and Canada, while Location IQ and OSM have worldwide coverage. The Census and OSM services support batch geocoding (Location IQ and OSM do not).

The Census and OSM services are free while both Geocodio and Location IQ are commercial services that require API keys, but also offer free usage tiers. OSM and Location IQ both have usage frequency limits. Refer to the websites and documentation of the geocoder services for more details.
The Census and OSM services are free; Geocodio and Location IQ are commercial services that require API keys, but also offer free usage tiers. OSM and Location IQ both have usage frequency limits. Refer to the documentation of each service for more details.

## Installation

Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,9 @@ MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/je

## Introduction

Tidygeocoder makes getting data from geocoding services easy. The
currently supported services are the [US Census
geocoder](https://geocoding.geo.census.gov/), [Nominatim
(OSM)](https://nominatim.org), [Geocodio](https://www.geocod.io/), and
[Location IQ](https://locationiq.com/). In addition to the usage example
below, you can find a blog post on geocoding landmarks in Washington, DC
Tidygeocoder makes getting data from geocoder services easy. In addition
to the usage example below, you can find a blog post on geocoding
landmarks in Washington, DC
[here](https://jessecambon.github.io/2019/11/11/tidygeocoder-demo.html).

All results are returned in [tibble
Expand All @@ -31,16 +28,19 @@ data are preserved.

## Geocoder Services

The Census geocoder is restricted to street-level addresses in the
United States, Geocodio covers the U.S. and Canada, while Location IQ
and OSM have worldwide coverage. The Census and OSM services support
batch geocoding while Location IQ and OSM do not.

The Census and OSM services are free while both Geocodio and Location IQ
are commercial services that require API keys, but also offer free usage
The currently supported services are the [US Census
geocoder](https://geocoding.geo.census.gov/), [Nominatim
(OSM)](https://nominatim.org), [Geocodio](https://www.geocod.io/), and
[Location IQ](https://locationiq.com/). The Census geocoder is
restricted to street-level addresses in the United States, Geocodio
covers the U.S. and Canada, while Location IQ and OSM have worldwide
coverage. The Census and OSM services support batch geocoding (Location
IQ and OSM do not).

The Census and OSM services are free; Geocodio and Location IQ are
commercial services that require API keys, but also offer free usage
tiers. OSM and Location IQ both have usage frequency limits. Refer to
the websites and documentation of the geocoder services for more
details.
the documentation of each service for more details.

## Installation

Expand Down
6 changes: 3 additions & 3 deletions docs/articles/tidygeocoder.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ pkgdown: 1.5.1
pkgdown_sha: ~
articles:
tidygeocoder: tidygeocoder.html
last_built: 2020-07-14T19:25Z
last_built: 2020-07-14T20:28Z
urls:
reference: https://jessecambon.github.io/tidygeocoder/reference
article: https://jessecambon.github.io/tidygeocoder/articles
Expand Down
Binary file modified docs/reference/figures/README-unnamed-chunk-6-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-unnamed-chunk-6-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit aa1322d

Please sign in to comment.