zipcodeR-package

zipcodeR

zipcodeR provides two deliberately separate interfaces.

internal

Make working with ZIP codes in R painless with an integrated dataset of U.S. ZIP codes and functions for working with them.
Search ZIP codes by multiple geographies, including state, county, city & across time zones. Also included are functions for relating
ZIP codes to Census data, geocoding & distance calculations. New
analyses can select an immutable modern data bundle through the
next-generation API, while the historical interface remains
compatible with version 0.3.5 for reproducible research.

Gavin Rozzi

Data & Functions for Working with US ZIP Codes

zipcodeR-package function

Use functions ending in <code>_ng</code> with an explicitly selected data bundle. Start
with <code>download_zip_data_bundle()</code> for a registered immutable version or
<code>read_zip_data_bundle()</code> for a local checksum-pinned file. Passing the bundle
as the first argument makes the chosen data vintage visible in every call.
<code>_ng</code> never resolves an implicit <code>latest</code> version or downloads during a
lookup.

Recommended interface for new analyses

Unsuffixed functions and the datasets in <code>data/</code> retain the exact zipcodeR
0.3.5 contract for existing scripts and research reproduction. This includes
historical data, scientific algorithms, conditions, ordering, and known edge
cases. Use <code>zip_data_version()</code> to record which contract an analysis used.

Historical compatibility interface

Maintainer: Gavin Rozzi <a href="/link/gr%40gavinrozzi.com?package=zipcodeR&version=0.4.0" data-mini-rdoc="zipcodeR::gr@gavinrozzi.com">gr@gavinrozzi.com</a> (<a href="https://orcid.org/0000-0002-9969-8175">ORCID</a>)
Authors:<ul>
<li>Gavin Rozzi <a href="/link/gr%40gavinrozzi.com?package=zipcodeR&version=0.4.0" data-mini-rdoc="zipcodeR::gr@gavinrozzi.com">gr@gavinrozzi.com</a> (<a href="https://orcid.org/0000-0002-9969-8175">ORCID</a>)</li>
</ul>

Author

zipcodeR: reproducible U.S. ZIP-code analysis — zipcodeR-package

Use functions ending in <code>_ng</code> with an explicitly selected data bundle. Start
with <code>download_zip_data_bundle()</code> for a registered immutable version or
<code>read_zip_data_bundle()</code> for a local checksum-pinned file. Passing the bundle
as the first argument makes the chosen data vintage visible in every call.
<code>_ng</code> never resolves an implicit <code>latest</code> version or downloads during a
lookup.

Unsuffixed functions and the datasets in <code>data/</code> retain the exact zipcodeR
0.3.5 contract for existing scripts and research reproduction. This includes
historical data, scientific algorithms, conditions, ordering, and known edge
cases. Use <code>zip_data_version()</code> to record which contract an analysis used.

Maintainer: Gavin Rozzi <a href='mailto:gr@gavinrozzi.com'>gr@gavinrozzi.com</a> (<a href='https://orcid.org/0000-0002-9969-8175'>ORCID</a>)
Authors:<ul>
<li>Gavin Rozzi <a href='mailto:gr@gavinrozzi.com'>gr@gavinrozzi.com</a> (<a href='https://orcid.org/0000-0002-9969-8175'>ORCID</a>)</li>
</ul>

zipcodeR-package: zipcodeR: reproducible U.S. ZIP-code analysis

Description

Arguments

Recommended interface for new analyses

Historical compatibility interface

Author

See Also