Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed
- Updated `NEWS.md`, `README.md`/`README.Rmd`, and `cran-comments.md` with full 0.2.0 release notes, a "What's New" section, and expanded CRAN reviewer summary (#73)

### Added
- Extended TIGRIS year availability from 2023 to 2024 in `zi_get_geometry()`; `zi_list_zctas()` accepts 2024 in the valid range but aborts with an informative message until `sysdata.rda` is rebuilt (#45)
- Updated `inst/build-data/build_vectors.R` to download and process 2024 ZCTA data, enabling future `sysdata.rda` rebuild (#45)
Expand Down
20 changes: 19 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
# zippeR 0.2.0

* Bump version for next CRAN release
## New features and improvements

* UDS Mapper crosswalk data (2009–2022) is now bundled with the package, eliminating the runtime network dependency on an external GitHub repository
* Partial support for 2024 TIGRIS year: `zi_list_zctas()` accepts 2024 in its valid range, and `zi_get_geometry()` accepts the argument but aborts with an informative message until internal data is rebuilt in a future release
* Deprecated parameter aliases `input_zip` and `dict` in `zi_crosswalk()` with backwards-compatible support until early 2027
* `@examplesIf` guards replace `\donttest{}`/`\dontrun{}` wrappers in all network-dependent and API-key-dependent examples
* Minimum R version set to 4.1

## Bug fixes

* Resolved several input validation gaps across `zi_aggregate()`, `zi_crosswalk()`, `zi_convert()`, `zi_get_geometry()`, `zi_get_demographics()`, `zi_load_crosswalk()`, `zi_load_labels()`, `zi_load_labels_list()`, `zi_prep_hud()`, `zi_repair()`, and `zi_validate()`
* Fixed a number of incorrect column references, variable scoping errors, and unsafe dispatch patterns identified during a code quality audit
* Replaced live Census API calls in tests with local fixtures so `R CMD check` passes on CRAN without a Census API key
* Normalized non-standard column names in the 2015 UDS crosswalk

## Dependency changes

* Dropped `purrr`, `spatstat.univar`, `stringr`, `httr`, `readr`, and `tidyr` from Imports
* Added `httr2 (>= 1.0.0)` to Imports

# zippeR 0.1.2

Expand Down
12 changes: 11 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,22 @@ The development version of `zippeR` can be accessed from GitHub with `remotes`:
remotes::install_github("pfizer-opensource/zippeR")
```

## What's New in v0.2.0

* **Bundled UDS crosswalk data** — The UDS Mapper ZIP-to-ZCTA crosswalk files (2009–2022) are now included directly in the package, so `zi_load_crosswalk()` no longer requires a network connection for UDS lookups.
* **Lighter dependency footprint** — Six packages (`purrr`, `spatstat.univar`, `stringr`, `httr`, `readr`, and `tidyr`) have been dropped from Imports, replaced with base-R equivalents or `httr2`.
* **Bug fix and input validation sweep** — A code quality audit identified and resolved a broad set of issues including incorrect column references, unsafe dispatch patterns, and missing input guards across nearly all major functions.
* **Partial 2024 TIGRIS year support** — `zi_list_zctas()` and `zi_get_geometry()` now accept 2024 as a valid year; full geometry data for 2024 will be available in a future release.

See `NEWS.md` for the full list of changes.

## Usage
`zippeR` contains functions that support the following tasks:
* Labeling five-digit and three-digit ZIP Codes
* Converting ZIP Codes to ZCTAs, counties, and other Census geographies
* Downloading ZCTA geometries for both five-digit and three-digit areas
* Aggregating demographic data from five-digit ZCTAs to three-digit ZCTAs
* Accessing bundled, offline UDS Mapper ZIP-to-ZCTA crosswalk data (2009–2022)

While a quick overview of the the core functionality is below, see the vignettes and our package website for more information on how to use these functions.

Expand All @@ -68,7 +78,7 @@ The `zi_load_crosswalk()` function provides access to the former UDS Mapper proj
# … with 41,086 more rows
```

Likewise, users can use the `zip_load_crosswalk()` function combined with a HUD API key to access the HUD USPS ZIP Code Crosswalk. This function returns a data frame with ZIP Codes and their corresponding Census geographies:
Likewise, users can use the `zi_load_crosswalk()` function combined with a HUD API key to access the HUD USPS ZIP Code Crosswalk. This function returns a data frame with ZIP Codes and their corresponding Census geographies:

```r
zi_load_crosswalk(zip_source = "HUD", year = 2023, qtr = 1, target = "COUNTY",
Expand Down
30 changes: 25 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,33 @@ The development version of `zippeR` can be accessed from GitHub with
remotes::install_github("pfizer-opensource/zippeR")
```

## What’s New in v0.2.0

- **Bundled UDS crosswalk data** — The UDS Mapper ZIP-to-ZCTA crosswalk
files (2009–2022) are now included directly in the package, so
`zi_load_crosswalk()` no longer requires a network connection for UDS
lookups.
- **Lighter dependency footprint** — Six packages (`purrr`,
`spatstat.univar`, `stringr`, `httr`, `readr`, and `tidyr`) have been
dropped from Imports, replaced with base-R equivalents or `httr2`.
- **Bug fix and input validation sweep** — A code quality audit
identified and resolved a broad set of issues including incorrect
column references, unsafe dispatch patterns, and missing input guards
across nearly all major functions.
- **Partial 2024 TIGRIS year support** — `zi_list_zctas()` and
`zi_get_geometry()` now accept 2024 as a valid year; full geometry
data for 2024 will be available in a future release.

See `NEWS.md` for the full list of changes.

## Usage

`zippeR` contains functions that support the following tasks: \*
Labeling five-digit and three-digit ZIP Codes \* Converting ZIP Codes to
ZCTAs, counties, and other Census geographies \* Downloading ZCTA
geometries for both five-digit and three-digit areas \* Aggregating
demographic data from five-digit ZCTAs to three-digit ZCTAs
demographic data from five-digit ZCTAs to three-digit ZCTAs \* Accessing
bundled, offline UDS Mapper ZIP-to-ZCTA crosswalk data (2009–2022)

While a quick overview of the the core functionality is below, see the
vignettes and our package website for more information on how to use
Expand Down Expand Up @@ -75,10 +95,10 @@ data frame with ZIP Codes and their corresponding ZCTAs.
# … with 41,086 more rows
```

Likewise, users can use the `zip_load_crosswalk()` function combined
with a HUD API key to access the HUD USPS ZIP Code Crosswalk. This
function returns a data frame with ZIP Codes and their corresponding
Census geographies:
Likewise, users can use the `zi_load_crosswalk()` function combined with
a HUD API key to access the HUD USPS ZIP Code Crosswalk. This function
returns a data frame with ZIP Codes and their corresponding Census
geographies:

``` r
zi_load_crosswalk(zip_source = "HUD", year = 2023, qtr = 1, target = "COUNTY",
Expand Down
8 changes: 7 additions & 1 deletion cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
## Release summary
This is a minor release of `zippeR` (0.2.0) for CRAN.
This is a minor release of `zippeR` (0.2.0) for CRAN. Key changes include:

* Bundled UDS Mapper ZIP-to-ZCTA crosswalk data (2009–2022) directly in the package, removing the runtime network dependency on an external GitHub repository
* Dropped six packages from Imports (`purrr`, `spatstat.univar`, `stringr`, `httr`, `readr`, `tidyr`), replacing them with base-R equivalents or `httr2`
* Resolved a broad set of input validation gaps, incorrect column references, and unsafe dispatch patterns identified during a code quality audit
* Replaced live Census API calls in the test suite with local fixtures so checks pass on CRAN without a Census API key
* Set minimum R version to 4.1

## Test environments
* local macOS install: R 4.4.3
Expand Down
Loading