Skip to content

Align docs and behavior: address purpose, empty results, validation#86

Merged
frankfarach merged 6 commits into
masterfrom
feature/align-docs-code
Dec 31, 2025
Merged

Align docs and behavior: address purpose, empty results, validation#86
frankfarach merged 6 commits into
masterfrom
feature/align-docs-code

Conversation

@frankfarach
Copy link
Copy Markdown
Collaborator

Summary

  • Normalize address_purpose inputs to API uppercase values and add coverage.
  • Return a typed npi_results object for zero‑record searches.
  • Vectorize npi_is_valid() for multiple NPIs.
  • Clarify taxonomy fallback behavior in npi_summarize docs and README.
  • Add Author/Maintainer fields for R CMD check.
  • Update NEWS.md and refresh roxygen output.

Changes

  • npi_search() accepts case‑insensitive address_purpose and normalizes to LOCATION/MAILING/PRIMARY/
    SECONDARY.
  • Zero‑record searches return a structured npi_results.
  • npi_is_valid() returns logical vectors for vector inputs.
  • npi_summarize documentation notes fallback to first taxonomy if none marked primary.
  • NEWS.md updated; roxygen regenerated (RoxygenNote updated).

Testing

  • R CMD build .
  • R CMD check npi_0.2.0.9000.tar.gz

Notes

  • No behavior changes beyond the described alignments; existing pipelines should remain compatible.

Accept case-insensitive address_purpose values and normalize to API constants; add unit test for secondary -> SECONDARY.
Allow vector inputs and return logical vectors; add tests for vector validation.
Return a structured npi_results for zero-record searches; keep npi column integer for consistent binding; update empty-result test.
Clarify that npi_summarize falls back to the first taxonomy when no primary is marked; update README and Rd docs.
Document recent changes in NEWS and refresh roxygen output.
@frankfarach frankfarach self-assigned this Dec 31, 2025
@frankfarach frankfarach merged commit 8db3f8c into master Dec 31, 2025
14 checks passed
@frankfarach frankfarach deleted the feature/align-docs-code branch December 31, 2025 06:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant