Skip to contents

Changelog

Source: NEWS.md

nwaa 0.1.4

CRAN release: 2026-08-20

  • CRAN resubmission (documentation only). Removed the single quotes around the USGS and NWAA acronyms in the Title and Description, and wrapped the runnable data-download examples in \donttest{} so they execute during checks. One atmospheric-forcing example was narrowed to a single HUC12 so every executed example finishes in well under five seconds.

nwaa 0.1.3

  • Removed the USGS documentation links from the DESCRIPTION, help pages, and the introductory vignette. The USGS web server blocks automated requests from outside the United States, so these otherwise-valid links were reported as unreachable (HTTP 404) by CRAN’s URL checker. The service is now referred to by name; the runtime API endpoint used by the package is unaffected. The full set of USGS reference links remains in the GitHub README.
  • Geographic identifier columns in CSV responses (e.g. huc12_id) are now always returned as character. Previously they were left to readr’s type guessing, which read them as numeric – rendering a HUC12 id such as 180300010602 as 1.803e+11 and stripping leading zeros from FIPS codes (06029 became 6029). Identifiers are labels, not quantities, so they are now pinned to character while genuinely numeric variables are unaffected.
  • Fixed a broken link to the LICENSE file in the README.

nwaa 0.1.2

  • Enabled annual resolutions (annualcy and annualwy) for the Water Quantity and Integrated Water Availability models, which were previously restricted to monthly. Live probes confirmed the NWAA data endpoint aggregates every model to annual server-side, so all ten models now accept all three temporal resolutions.
  • Added the two standalone hydrologic component models that make up the ensemble, bringing catalog coverage to all ten published NWAA models: wqn-nhmprms-conus-nwaa-v1 (NHM-PRMS) and wqn-wrfhydro-conus-nwaa-v1 (WRF-Hydro). Both are reached through nwaa_hydro(model_id = ...) and expose two variables beyond the ensemble: soil moisture (soilmst, mm) and recharge (recharge, mm/mo). Variables, units, and periods of record were confirmed against each model’s config JSON and live API responses.
  • Removed a stray httptest2 mock (data-581705.R) that had been recorded outside the fixtures/ tree.

nwaa 0.1.0

Initial release.

Features

  • Programmatic R interface to the USGS National Water Availability Assessment (NWAA) Data Companion web service.
  • Coverage of all eight currently published NWAA models across three families.
    • Water Use: irrigation withdrawals (wu-irrigation-wd), irrigation consumptive use (wu-irrigation-cu), public supply withdrawals (wu-public-supply-wd), public supply consumptive use (wu-public-supply-cu), thermoelectric (wu-thermoelectric).
    • Water Quantity: atmospheric forcing WRF CONUS404-BA (wqn-conus404-ba), hydrologic ensemble NHM-PRMS plus WRF-Hydro (wqn-ensemble-conus-nwaa-v1).
    • Integrated Water Availability: water budget assessment with surface water supply and use index (iwa-assessment-outputs-conus-2025).
  • Family-organized wrappers: nwaa_water_use(), nwaa_atmos(), nwaa_hydro(), nwaa_iwa().
  • Unified catalog nwaa_catalog() listing every model, variable, unit, period of record, and supported temporal resolutions.
  • Request validation against the catalog before any network call. Invalid model IDs, variables incompatible with a model, and unsupported temporal resolutions all fail fast with readable messages.
  • Location specification by Hydrologic Unit Code at HUC2, HUC4, HUC6, HUC8, HUC10, or HUC12 resolution, by lowercase two-letter state abbreviation (statecd), or by five-digit county FIPS code (countycd). Polygon selectors return HUC12 results aggregated server-side.
  • Polygon intersection control through the intersection argument: "overlap" (default, includes any HUC12 touching the polygon) and "envelop" (HUC12s at least 98% inside).
  • Three date-range modes through the range argument: "recent" (most recent timepoint), "historical" (full published period of record), and "custom" (user-supplied start and end).
  • Temporal resolution support reflects what the upstream USGS READMEs document. Water Use models support monthly, annualcy (calendar year), and annualwy (water year). Water Quantity and Integrated Water Availability models are documented as monthly products and the catalog reflects that; users wanting annual rollups can aggregate the monthly response client-side.
  • Output formats: CSV (default), JSON, and GeoJSON.

Documentation

Testing

  • Test suite covering catalog structure, request validation, query construction, location resolution, date-range resolution including the USGS Water Year convention, and end-to-end fetch behavior.
  • Offline test suite using httptest2 fixtures recorded against the live API, so R CMD check does not require network access.
  • Continuous integration via GitHub Actions covering Ubuntu, macOS, and Windows on R release, devel, and oldrel-1.