Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to include more context #15

Open
francisbarton opened this issue Jan 12, 2024 · 1 comment
Open

Update README to include more context #15

francisbarton opened this issue Jan 12, 2024 · 1 comment
Assignees

Comments

@francisbarton
Copy link
Collaborator

  • Differences between ONSPD and NHSPD
  • Features of the above including update schedule and whether they contain retired postcodes or just current
  • How to use package functions to query the postcodes.io API
  • How to use package functions to suggest potentially "corrected" postcodes for datasets that have invalid codes
  • Other ways to access the NHSPD eg via the NHS API, as well as ONS OpenGeography. Different formats.
  • How to solve common problems
@francisbarton francisbarton self-assigned this Jan 12, 2024
@Lextuga007
Copy link
Member

For {NHSRpopulation} we used pkgdown to build a site and if you call the vignette the same name as the repo and _pkgdown.yml has intro listed it sets up a Get Started vignette with its own url along the top. That might be better than a longer README. I've linked to the vignettes in the {NHSRpopulation} README for the benefit of new users who aren't aware of the link in the top right of the repository in GitHub.

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

No branches or pull requests

2 participants