The NHSBSA Open Data Portal | The API and the response envelope | What the package wraps | Working with the returned objects | From the portal website to the API | A worked example | Find a dataset | Inspect a dataset's resources | Download a resource file | Query rows without downloading the whole file | Ways to query datastore data | Reading rows with nhsbsa_datastore_search() | Filtering and aggregating with SQL
Package: nhsbsa 0.1.0
nhsbsa: Client for the NHS Business Services Authority Open Data Portal
A low-level client for the National Health Service Business Services Authority (NHSBSA) Open Data Portal <https://opendata.nhsbsa.net>, a 'CKAN' data catalogue. Provides thin wrappers around the portal's API actions for listing datasets, retrieving metadata, querying the datastore and downloading resource files. Results are returned as plain data (tibbles and lists) for the caller to interpret.
Authors:
nhsbsa_0.1.0.tar.gz
nhsbsa_0.1.0.zip(r-4.7-any)nhsbsa_0.1.0.zip(r-4.6-any)nhsbsa_0.1.0.zip(r-4.5-any)
nhsbsa_0.1.0.tgz(r-4.6-any)nhsbsa_0.1.0.tgz(r-4.5-any)
nhsbsa_0.1.0.tar.gz(r-4.7-any)nhsbsa_0.1.0.tar.gz(r-4.6-any)
nhsbsa_0.1.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
nhsbsa/json (API)
| # Install 'nhsbsa' in R: |
| install.packages('nhsbsa', repos = c('https://rmgpanw.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/rmgpanw/nhsbsa/issues
Pkgdown/docs site:https://rmgpanw.github.io
Last updated from:eba21be983. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel | OK | 123 | ||
| source / vignettes | OK | 172 | ||
| linux-release | OK | 119 | ||
| macos-release | OK | 132 | ||
| macos-oldrel | OK | 169 | ||
| windows-devel | OK | 79 | ||
| windows-release | OK | 87 | ||
| windows-oldrel | OK | 72 | ||
| wasm-release | OK | 96 |
Exports:nhsbsa_datastore_searchnhsbsa_datastore_search_sqlnhsbsa_download_resourcenhsbsa_group_listnhsbsa_list_resourcesnhsbsa_organization_listnhsbsa_package_listnhsbsa_package_searchnhsbsa_package_shownhsbsa_resource_shownhsbsa_tag_list
Dependencies:askpassclicurldplyrgenericsgluehttr2jsonlitelifecyclemagrittropensslpillarpkgconfigpurrrR6rlangstringistringrsystibbletidyselectutf8vctrswithr
Getting started with nhsbsa
Last update: 2026-07-18
Started: 2026-06-27
Developer guide
Design goals | Architecture | The core request layer (R/core.R) | Conditions (R/conditions.R) | Return-type conventions | Which actions are wrapped | Adding a new endpoint | Testing | Offline tests with recorded fixtures | Offline tests with mocked responses | Live tests | Checks before a pull request
Last update: 2026-06-27
Started: 2026-06-27
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Search a resource's rows | nhsbsa_datastore_search |
| Query a resource with SQL | nhsbsa_datastore_search_sql |
| Download a resource file | nhsbsa_download_resource |
| List dataset groups | nhsbsa_group_list |
| List a dataset's resources as a tibble | nhsbsa_list_resources |
| List publishing organisations | nhsbsa_organization_list |
| List available datasets | nhsbsa_package_list |
| Search datasets | nhsbsa_package_search |
| Show a dataset's metadata | nhsbsa_package_show |
| Show a resource's metadata | nhsbsa_resource_show |
| List tags | nhsbsa_tag_list |
| Methods for nhsbsa objects | as_tibble.nhsbsa_package as_tibble.nhsbsa_package_search nhsbsa-methods print.nhsbsa_package print.nhsbsa_package_search print.nhsbsa_resource |