trud: Query the 'NHS TRUD API' (full submission) #705
Comments
|
@rmgpanw You've used the pre-submission template here, instead of the one for full submissions. Can you please:
The bot checks may not be automatically triggered, so you might also need to manually call |
|
Apologies @mpadge, hopefully I've corrected this now! |
|
@ropensci-review-bot check package |
|
Thanks, about to send the query. |
|
🚀 Editor check started 👋 |
Checks for trud (v0.1.0.9000)git hash: aa883f7f
Important: All failing checks above must be addressed prior to proceeding Package License: MIT + file LICENSE 1. Package DependenciesDetails of Package Dependency Usage (click to open)
The table below tallies all function calls to all packages ('ncalls'), both internal (r-base + recommended, along with the package itself), and external (imported and suggested packages). 'NA' values indicate packages to which no identified calls to R functions could be found. Note that these results are generated by an automated code-tagging system which may not be entirely accurate.
Click below for tallies of functions used in each package. Locations of each call within this package may be generated locally by running 's <- pkgstats::pkgstats(<path/to/repo>)', and examining the 'external_calls' table. basec (13), class (2), message (2), paste0 (2), url (2), as.integer (1), body (1), call (1), environment (1), file.path (1), Sys.setenv (1), tryCatch (1), with (1) trudget_item_metadata (3), get_trud_items_html (2), request_download_item (2), request_item_metadata (2), trud_error_message (2), trud_items (2), download_item (1), get_subscribed_metadata (1), get_trud_api_key (1), req_user_agent_trud (1) rvesthtml_attr (1), html_elements (1), html_text (1) httr2req_error (1), req_perform (1) purrrpluck (2) stringrstr_glue (2) utilspage (2) dplyrmutate (1) methodsas (1) rlangcaller_env (1) statsdf (1) tibbletibble (1) NOTE: Some imported packages appear to have no associated function calls; please ensure with author that these 'Imports' are listed appropriately. 2. Statistical PropertiesThis package features some noteworthy statistical properties which may need to be clarified by a handling editor prior to progressing. Details of statistical properties (click to open)
The package has:
Statistical properties of package structure as distributional percentiles in relation to all current CRAN packages
All parameters are explained as tooltips in the locally-rendered HTML version of this report generated by the The final measure (
2a. Network visualisationClick to see the interactive network visualisation of calls between objects in package 3.
|
| id | name | conclusion | sha | run_number | date |
|---|---|---|---|---|---|
| 14912366508 | Draft PDF | success | aa883f | 6 | 2025-05-08 |
| 14912511223 | pages build and deployment | success | 0c3012 | 34 | 2025-05-08 |
| 14912366515 | pkgcheck | cancelled | aa883f | 10 | 2025-05-08 |
| 14912366495 | pkgdown | success | aa883f | 35 | 2025-05-08 |
| 14912366507 | R-CMD-check | success | aa883f | 25 | 2025-05-08 |
| 14912366493 | test-coverage | success | aa883f | 30 | 2025-05-08 |
3b. goodpractice results
R CMD check with rcmdcheck
R CMD check generated the following error:
- checking tests ...
Running ‘spelling.R’
Comparing ‘spelling.Rout’ to ‘spelling.Rout.save’ ... OK
Running ‘testthat.R’
ERROR
Running the tests in ‘tests/testthat.R’ failed.
Last 13 lines of output:
Error inget_subscribed_metadata(): x Can't find NHS TRUD API key
i Set your NHS TRUD API key as an environment variable usingSys.setenv(TRUD_API_KEY='<<your-key>>'), or preferably use a.Renvironfile
i To get an API key, first sign up for a NHS TRUD account at https://isd.digital.nhs.uk/trud/users/guest/filters/0/account/form
i To find Your API key, log in and visit your account profile page (https://isd.digital.nhs.uk/trud/users/authenticated/filters/0/account/manage).
Backtrace:
▆- ├─testthat::with_mocked_bindings(...) at test-get_subscribed_metadata.R:2:3
- └─trud::get_subscribed_metadata() at test-get_subscribed_metadata.R:14:7
- └─trud:::get_trud_api_key(TRUD_API_KEY)
-
└─cli::cli_abort(...) -
└─rlang::abort(...)
[ FAIL 6 | WARN 0 | SKIP 5 | PASS 14 ]
Error: Test failures
Execution halted
R CMD check generated the following test_fail:
-
This file is part of the standard setup for testthat.
It is recommended that you do not modify it.
Where should you do additional test configuration?
Learn more about the roles of various files in:
* https://r-pkgs.org/testing-design.html#sec-tests-files-overview
* https://testthat.r-lib.org/articles/special-files.html
library(testthat)
library(trud)test_check("trud")
[ FAIL 6 | WARN 0 | SKIP 5 | PASS 14 ]
══ Skipped tests (5) ═══════════════════════════════════════════════════════════
• identical(Sys.getenv("TRUD_API_KEY"), "") is TRUE (5):
'test-get_item_metadata.R:27:3', 'test-get_item_metadata.R:45:5',
'test-get_item_metadata.R:77:3', 'test-get_subscribed_metadata.R:28:3',
'test-trud_items.R:36:3'
══ Failed tests ════════════════════════════════════════════════════════════════
── Error ('test-download_item.R:2:3'): Expected errors raised for invalid release arg with download_item() ──
<missing_api_key/rlang_error/error/condition>
Error in download_item(394, release = 1): x Can't find NHS TRUD API key
i Set your NHS TRUD API key as an environment variable using Sys.setenv(TRUD_API_KEY='<<your-key>>'), or preferably use a .Renviron file
i To get an API key, first sign up for a NHS TRUD account at https://isd.digital.nhs.uk/trud/users/guest/filters/0/account/form
i To find Your API key, log in and visit your account profile page (https://isd.digital.nhs.uk/trud/users/authenticated/filters/0/account/manage).
Backtrace:
▆
- ├─testthat::expect_error(download_item(394, release = 1), "Argument
releasemust be a string") at test-download_item.R:2:3 - │ └─testthat:::expect_condition_matching(...)
- │ └─testthat:::quasi_capture(...)
- │ ├─testthat (local) .capture(...)
- │ │ └─base::withCallingHandlers(...)
- │ └─rlang::eval_bare(quo_get_expr(.quo), quo_get_env(.quo))
- └─trud::download_item(394, release = 1)
- └─trud:::get_trud_api_key(TRUD_API_KEY)
-
└─cli::cli_abort(...) -
└─rlang::abort(...)
── Error ('test-download_item.R:37:7'): Warning raised if file to be downloaded already exists locally ──
<missing_api_key/rlang_error/error/condition>
Error in download_item(394, release = "item1", directory = tempdir()): x Can't find NHS TRUD API key
i Set your NHS TRUD API key as an environment variable using Sys.setenv(TRUD_API_KEY='<<your-key>>'), or preferably use a .Renviron file
i To get an API key, first sign up for a NHS TRUD account at https://isd.digital.nhs.uk/trud/users/guest/filters/0/account/form
i To find Your API key, log in and visit your account profile page (https://isd.digital.nhs.uk/trud/users/authenticated/filters/0/account/manage).
Backtrace:
▆
- ├─testthat::with_mocked_bindings(...) at test-download_item.R:27:3
- ├─testthat::expect_warning(...) at test-download_item.R:37:7
- │ └─testthat:::expect_condition_matching(...)
- │ └─testthat:::quasi_capture(...)
- │ ├─testthat (local) .capture(...)
- │ │ └─base::withCallingHandlers(...)
- │ └─rlang::eval_bare(quo_get_expr(.quo), quo_get_env(.quo))
- └─trud::download_item(394, release = "item1", directory = tempdir())
- └─trud:::get_trud_api_key(TRUD_API_KEY)
-
└─cli::cli_abort(...) -
└─rlang::abort(...)
── Error ('test-download_item.R:64:7'): download_item() works ────────────────
<missing_api_key/rlang_error/error/condition>
Error in download_item(394, release = "item1", directory = tempdir()): x Can't find NHS TRUD API key
i Set your NHS TRUD API key as an environment variable using Sys.setenv(TRUD_API_KEY='<<your-key>>'), or preferably use a .Renviron file
i To get an API key, first sign up for a NHS TRUD account at https://isd.digital.nhs.uk/trud/users/guest/filters/0/account/form
i To find Your API key, log in and visit your account profile page (https://isd.digital.nhs.uk/trud/users/authenticated/filters/0/account/manage).
Backtrace:
▆
- ├─testthat::with_mocked_bindings(...) at test-download_item.R:47:3
- ├─testthat::expect_equal(...) at test-download_item.R:64:7
- │ └─testthat::quasi_label(enquo(object), label, arg = "object")
- │ └─rlang::eval_bare(expr, quo_get_env(quo))
- └─trud::download_item(394, release = "item1", directory = tempdir())
- └─trud:::get_trud_api_key(TRUD_API_KEY)
-
└─cli::cli_abort(...) -
└─rlang::abort(...)
── Error ('test-get_item_metadata.R:2:3'): Error raised with invalid latest_only arg value for get_item_metadata() ──
<missing_api_key/rlang_error/error/condition>
Error in get_item_metadata(394, latest_only = "TRUE"): x Can't find NHS TRUD API key
i Set your NHS TRUD API key as an environment variable using Sys.setenv(TRUD_API_KEY='<<your-key>>'), or preferably use a .Renviron file
i To get an API key, first sign up for a NHS TRUD account at https://isd.digital.nhs.uk/trud/users/guest/filters/0/account/form
i To find Your API key, log in and visit your account profile page (https://isd.digital.nhs.uk/trud/users/authenticated/filters/0/account/manage).
Backtrace:
▆
- ├─testthat::expect_error(...) at test-get_item_metadata.R:2:3
- │ └─testthat:::expect_condition_matching(...)
- │ └─testthat:::quasi_capture(...)
- │ ├─testthat (local) .capture(...)
- │ │ └─base::withCallingHandlers(...)
- │ └─rlang::eval_bare(quo_get_expr(.quo), quo_get_env(.quo))
- └─trud::get_item_metadata(394, latest_only = "TRUE")
- └─trud:::get_trud_api_key(TRUD_API_KEY)
-
└─cli::cli_abort(...) -
└─rlang::abort(...)
── Error ('test-get_item_metadata.R:18:7'): get_item_metadata() runs with mocked API response ──
<missing_api_key/rlang_error/error/condition>
Error in get_item_metadata(394): x Can't find NHS TRUD API key
i Set your NHS TRUD API key as an environment variable using Sys.setenv(TRUD_API_KEY='<<your-key>>'), or preferably use a .Renviron file
i To get an API key, first sign up for a NHS TRUD account at https://isd.digital.nhs.uk/trud/users/guest/filters/0/account/form
i To find Your API key, log in and visit your account profile page (https://isd.digital.nhs.uk/trud/users/authenticated/filters/0/account/manage).
Backtrace:
▆
- ├─testthat::with_mocked_bindings(...) at test-get_item_metadata.R:9:3
- └─trud::get_item_metadata(394) at test-get_item_metadata.R:18:7
- └─trud:::get_trud_api_key(TRUD_API_KEY)
-
└─cli::cli_abort(...) -
└─rlang::abort(...)
── Error ('test-get_subscribed_metadata.R:14:7'): get_subscribed_metadata() runs as expected ──
<missing_api_key/rlang_error/error/condition>
Error in get_subscribed_metadata(): x Can't find NHS TRUD API key
i Set your NHS TRUD API key as an environment variable using Sys.setenv(TRUD_API_KEY='<<your-key>>'), or preferably use a .Renviron file
i To get an API key, first sign up for a NHS TRUD account at https://isd.digital.nhs.uk/trud/users/guest/filters/0/account/form
i To find Your API key, log in and visit your account profile page (https://isd.digital.nhs.uk/trud/users/authenticated/filters/0/account/manage).
Backtrace:
▆
- ├─testthat::with_mocked_bindings(...) at test-get_subscribed_metadata.R:2:3
- └─trud::get_subscribed_metadata() at test-get_subscribed_metadata.R:14:7
- └─trud:::get_trud_api_key(TRUD_API_KEY)
-
└─cli::cli_abort(...) -
└─rlang::abort(...)
[ FAIL 6 | WARN 0 | SKIP 5 | PASS 14 ]
Error: Test failures
Execution halted
R CMD check generated the following check_fail:
- rcmdcheck_tests_pass
Test coverage with covr
ERROR: Test Coverage Failed
Cyclocomplexity with cyclocomp
No functions have cyclocomplexity >= 15
Static code analyses with lintr
lintr found the following 46 potential issues:
| message | number of times |
|---|---|
| Avoid library() and require() calls in packages | 1 |
| Lines should not be more than 80 characters. This line is 100 characters. | 1 |
| Lines should not be more than 80 characters. This line is 105 characters. | 1 |
| Lines should not be more than 80 characters. This line is 108 characters. | 1 |
| Lines should not be more than 80 characters. This line is 111 characters. | 1 |
| Lines should not be more than 80 characters. This line is 112 characters. | 2 |
| Lines should not be more than 80 characters. This line is 113 characters. | 3 |
| Lines should not be more than 80 characters. This line is 115 characters. | 1 |
| Lines should not be more than 80 characters. This line is 117 characters. | 2 |
| Lines should not be more than 80 characters. This line is 118 characters. | 1 |
| Lines should not be more than 80 characters. This line is 147 characters. | 1 |
| Lines should not be more than 80 characters. This line is 165 characters. | 2 |
| Lines should not be more than 80 characters. This line is 81 characters. | 3 |
| Lines should not be more than 80 characters. This line is 82 characters. | 2 |
| Lines should not be more than 80 characters. This line is 83 characters. | 4 |
| Lines should not be more than 80 characters. This line is 84 characters. | 2 |
| Lines should not be more than 80 characters. This line is 85 characters. | 6 |
| Lines should not be more than 80 characters. This line is 86 characters. | 2 |
| Lines should not be more than 80 characters. This line is 87 characters. | 1 |
| Lines should not be more than 80 characters. This line is 88 characters. | 2 |
| Lines should not be more than 80 characters. This line is 89 characters. | 1 |
| Lines should not be more than 80 characters. This line is 90 characters. | 3 |
| Lines should not be more than 80 characters. This line is 93 characters. | 1 |
| Lines should not be more than 80 characters. This line is 97 characters. | 2 |
Package Versions
| package | version |
|---|---|
| pkgstats | 0.2.0.54 |
| pkgcheck | 0.1.2.126 |
Editor-in-Chief Instructions:
Processing may not proceed until the items marked with ✖️ have been resolved.
|
@ropensci-review-bot check package |
|
Thanks, about to send the query. |
|
🚀 Editor check started 👋 |
Checks for trud (v0.1.0.9000)git hash: 969f5d1c
Package License: MIT + file LICENSE 1. Package DependenciesDetails of Package Dependency Usage (click to open)
The table below tallies all function calls to all packages ('ncalls'), both internal (r-base + recommended, along with the package itself), and external (imported and suggested packages). 'NA' values indicate packages to which no identified calls to R functions could be found. Note that these results are generated by an automated code-tagging system which may not be entirely accurate.
Click below for tallies of functions used in each package. Locations of each call within this package may be generated locally by running 's <- pkgstats::pkgstats(<path/to/repo>)', and examining the 'external_calls' table. basec (13), class (2), message (2), paste0 (2), url (2), as.integer (1), body (1), call (1), environment (1), file.path (1), Sys.setenv (1), tryCatch (1), with (1) trudget_item_metadata (3), get_trud_items_html (2), request_download_item (2), request_item_metadata (2), trud_error_message (2), trud_items (2), download_item (1), get_subscribed_metadata (1), get_trud_api_key (1), req_user_agent_trud (1) rvesthtml_attr (1), html_elements (1), html_text (1) httr2req_error (1), req_perform (1) purrrpluck (2) stringrstr_glue (2) utilspage (2) dplyrmutate (1) methodsas (1) rlangcaller_env (1) statsdf (1) tibbletibble (1) NOTE: Some imported packages appear to have no associated function calls; please ensure with author that these 'Imports' are listed appropriately. 2. Statistical PropertiesThis package features some noteworthy statistical properties which may need to be clarified by a handling editor prior to progressing. Details of statistical properties (click to open)
The package has:
Statistical properties of package structure as distributional percentiles in relation to all current CRAN packages
All parameters are explained as tooltips in the locally-rendered HTML version of this report generated by the The final measure (
2a. Network visualisationClick to see the interactive network visualisation of calls between objects in package 3.
|
| id | name | conclusion | sha | run_number | date |
|---|---|---|---|---|---|
| 14924645040 | Draft PDF | success | 969f5d | 7 | 2025-05-09 |
| 14912511223 | pages build and deployment | success | 0c3012 | 34 | 2025-05-08 |
| 14924645045 | pkgcheck | NA | 969f5d | 11 | 2025-05-09 |
| 14924645044 | pkgdown | NA | 969f5d | 36 | 2025-05-09 |
| 14924645043 | R-CMD-check | NA | 969f5d | 26 | 2025-05-09 |
| 14924645060 | test-coverage | NA | 969f5d | 31 | 2025-05-09 |
3b. goodpractice results
R CMD check with rcmdcheck
rcmdcheck found no errors, warnings, or notes
Test coverage with covr
Package coverage: 91.44
Cyclocomplexity with cyclocomp
No functions have cyclocomplexity >= 15
Static code analyses with lintr
lintr found the following 46 potential issues:
| message | number of times |
|---|---|
| Avoid library() and require() calls in packages | 1 |
| Lines should not be more than 80 characters. This line is 100 characters. | 1 |
| Lines should not be more than 80 characters. This line is 105 characters. | 1 |
| Lines should not be more than 80 characters. This line is 108 characters. | 1 |
| Lines should not be more than 80 characters. This line is 111 characters. | 1 |
| Lines should not be more than 80 characters. This line is 112 characters. | 2 |
| Lines should not be more than 80 characters. This line is 113 characters. | 3 |
| Lines should not be more than 80 characters. This line is 115 characters. | 1 |
| Lines should not be more than 80 characters. This line is 117 characters. | 2 |
| Lines should not be more than 80 characters. This line is 118 characters. | 1 |
| Lines should not be more than 80 characters. This line is 147 characters. | 1 |
| Lines should not be more than 80 characters. This line is 165 characters. | 2 |
| Lines should not be more than 80 characters. This line is 81 characters. | 3 |
| Lines should not be more than 80 characters. This line is 82 characters. | 2 |
| Lines should not be more than 80 characters. This line is 83 characters. | 4 |
| Lines should not be more than 80 characters. This line is 84 characters. | 2 |
| Lines should not be more than 80 characters. This line is 85 characters. | 6 |
| Lines should not be more than 80 characters. This line is 86 characters. | 2 |
| Lines should not be more than 80 characters. This line is 87 characters. | 1 |
| Lines should not be more than 80 characters. This line is 88 characters. | 2 |
| Lines should not be more than 80 characters. This line is 89 characters. | 1 |
| Lines should not be more than 80 characters. This line is 90 characters. | 3 |
| Lines should not be more than 80 characters. This line is 93 characters. | 1 |
| Lines should not be more than 80 characters. This line is 97 characters. | 2 |
Package Versions
| package | version |
|---|---|
| pkgstats | 0.2.0.54 |
| pkgcheck | 0.1.2.126 |
Editor-in-Chief Instructions:
This package is in top shape and may be passed on to a handling editor
|
Thanks for submitting @rmgpanw, and great to see that you've got the tests working. I note only one aspect of the {pkgcheck} results here:
And clicking on the statistical properties section shows that is just that you have no documentation lines at all for non-exported functions. Documenting all functions both exported and internal greatly helps others to understand, and thereby contribute, to your package. You just need to add a Note also that the statistical properties provide immediate context for your statement that,
In Lines-of-Code, the standard and most direct measure of package size, it is in the 30th percentile, which is below average but definitely not too small, so rest assured, size is not an issue here. But thanks for pointing that out to us! Other than that, everything has been previously checked and approved in the pre-submission issue #689, so we're good to proceed here. We'll try to find a handling editor asap. You'll see here when that's been arranged. |
|
@ropensci-review-bot assign @emilyriederer as editor |
|
Assigned! @emilyriederer is now the editor |
|
@ropensci-review-bot check package |
|
Thanks, about to send the query. |
|
🚀 Editor check started 👋 |
Checks for trud (v0.1.0.9000)git hash: f48ca4d1
Package License: MIT + file LICENSE 1. Package DependenciesDetails of Package Dependency Usage (click to open)
The table below tallies all function calls to all packages ('ncalls'), both internal (r-base + recommended, along with the package itself), and external (imported and suggested packages). 'NA' values indicate packages to which no identified calls to R functions could be found. Note that these results are generated by an automated code-tagging system which may not be entirely accurate.
Click below for tallies of functions used in each package. Locations of each call within this package may be generated locally by running 's <- pkgstats::pkgstats(<path/to/repo>)', and examining the 'external_calls' table. basec (13), class (2), message (2), paste0 (2), url (2), as.integer (1), body (1), call (1), environment (1), file.path (1), Sys.setenv (1), tryCatch (1), with (1) trudget_item_metadata (3), get_trud_items_html (2), request_download_item (2), request_item_metadata (2), trud_error_message (2), trud_items (2), download_item (1), get_subscribed_metadata (1), get_trud_api_key (1), req_user_agent_trud (1) rvesthtml_attr (1), html_elements (1), html_text (1) httr2req_error (1), req_perform (1) purrrpluck (2) stringrstr_glue (2) utilspage (2) dplyrmutate (1) methodsas (1) rlangcaller_env (1) statsdf (1) tibbletibble (1) NOTE: Some imported packages appear to have no associated function calls; please ensure with author that these 'Imports' are listed appropriately. 2. Statistical PropertiesThis package features some noteworthy statistical properties which may need to be clarified by a handling editor prior to progressing. Details of statistical properties (click to open)
The package has:
Statistical properties of package structure as distributional percentiles in relation to all current CRAN packages
All parameters are explained as tooltips in the locally-rendered HTML version of this report generated by the The final measure (
2a. Network visualisationClick to see the interactive network visualisation of calls between objects in package 3.
|
| id | name | conclusion | sha | run_number | date |
|---|---|---|---|---|---|
| 15022557534 | Draft PDF | success | f48ca4 | 8 | 2025-05-14 |
| 15022748529 | pages build and deployment | success | 7578fb | 36 | 2025-05-14 |
| 15022557548 | pkgcheck | success | f48ca4 | 12 | 2025-05-14 |
| 15022557528 | pkgdown | success | f48ca4 | 37 | 2025-05-14 |
| 15022557537 | R-CMD-check | success | f48ca4 | 27 | 2025-05-14 |
| 15022557561 | test-coverage | success | f48ca4 | 32 | 2025-05-14 |
3b. goodpractice results
R CMD check with rcmdcheck
rcmdcheck found no errors, warnings, or notes
Test coverage with covr
Package coverage: 91.44
Cyclocomplexity with cyclocomp
No functions have cyclocomplexity >= 15
Static code analyses with lintr
lintr found the following 46 potential issues:
| message | number of times |
|---|---|
| Avoid library() and require() calls in packages | 1 |
| Lines should not be more than 80 characters. This line is 100 characters. | 1 |
| Lines should not be more than 80 characters. This line is 105 characters. | 1 |
| Lines should not be more than 80 characters. This line is 108 characters. | 1 |
| Lines should not be more than 80 characters. This line is 111 characters. | 1 |
| Lines should not be more than 80 characters. This line is 112 characters. | 2 |
| Lines should not be more than 80 characters. This line is 113 characters. | 3 |
| Lines should not be more than 80 characters. This line is 115 characters. | 1 |
| Lines should not be more than 80 characters. This line is 117 characters. | 2 |
| Lines should not be more than 80 characters. This line is 118 characters. | 1 |
| Lines should not be more than 80 characters. This line is 147 characters. | 1 |
| Lines should not be more than 80 characters. This line is 165 characters. | 2 |
| Lines should not be more than 80 characters. This line is 81 characters. | 3 |
| Lines should not be more than 80 characters. This line is 82 characters. | 2 |
| Lines should not be more than 80 characters. This line is 83 characters. | 4 |
| Lines should not be more than 80 characters. This line is 84 characters. | 2 |
| Lines should not be more than 80 characters. This line is 85 characters. | 6 |
| Lines should not be more than 80 characters. This line is 86 characters. | 2 |
| Lines should not be more than 80 characters. This line is 87 characters. | 1 |
| Lines should not be more than 80 characters. This line is 88 characters. | 2 |
| Lines should not be more than 80 characters. This line is 89 characters. | 1 |
| Lines should not be more than 80 characters. This line is 90 characters. | 3 |
| Lines should not be more than 80 characters. This line is 93 characters. | 1 |
| Lines should not be more than 80 characters. This line is 97 characters. | 2 |
Package Versions
| package | version |
|---|---|
| pkgstats | 0.2.0.54 |
| pkgcheck | 0.1.2.132 |
Editor-in-Chief Instructions:
This package is in top shape and may be passed on to a handling editor
|
Hi @rmgpanw ! I will be the handling editor for this package. Overall, the package looks to be in good shape to begin a review. I note you are still not passing the check for documenting non-exported functions. From your commit, it appears you added the necessary R files but may not have rerun I'll proceed to look for reviewers as this should not impact their ability to engage with the code, but this might be useful to add as you are able. |
|
@ropensci-review-bot seeking reviewers |
|
Please add this badge to the README of your package repository: [](https://github.com/ropensci/software-review/issues/705)Furthermore, if your package does not have a NEWS.md file yet, please create one to capture the changes made during the review process. See https://devguide.ropensci.org/releasing.html#news |
|
Hi @emilyriederer thanks for proceeding with the review! I have now added the rOpenSci status badge to the README. Regarding documentation for non-exported functions, I have tagged these with |
|
@ropensci-review-bot assign @AleKoure as reviewer |
|
@AleKoure added to the reviewers list. Review due date is 2025-06-18. Thanks @AleKoure for accepting to review! Please refer to our reviewer guide. rOpenSci’s community is our best asset. We aim for reviews to be open, non-adversarial, and focused on improving software quality. Be respectful and kind! See our reviewers guide and code of conduct for more. |
|
@ropensci-review-bot assign @jonclayden as reviewer |
|
@jonclayden added to the reviewers list. Review due date is 2025-06-18. Thanks @jonclayden for accepting to review! Please refer to our reviewer guide. rOpenSci’s community is our best asset. We aim for reviews to be open, non-adversarial, and focused on improving software quality. Be respectful and kind! See our reviewers guide and code of conduct for more. |
|
@jonclayden: If you haven't done so, please fill this form for us to update our reviewers records. |
ropensci-review-bot
added
3/reviewer(s)-assigned
and removed
2/seeking-reviewer(s)
labels
|
@rmgpanw -- Thank you for the explanation! My apologies, that's my oversight. That's good as-is. |
|
@rmgpanw -- I'm happy to introduce our two reviewers @jonclayden and @AleKoure. Both have backgrounds in API extraction and healthcare, so I'm grateful to bring their expertise into the review process. |
Uh oh!
There was an error while loading. Please reload this page.
Submitting Author Name: Alasdair Warwick
Due date for @AleKoure: 2025-06-18Submitting Author Github Handle: @rmgpanw
Other Package Authors Github handles: (comma separated, delete if none) @abolvera, @cyu12, @rnluben
Repository: https://github.com/rmgpanw/trud/
Submission type: Standard
Editor: @emilyriederer
Reviewers: @AleKoure, @jonclayden
Due date for @jonclayden: 2025-06-18
Archive: TBD
Version accepted: TBD
Language: en
Scope
Please indicate which category or categories from our package fit policies or statistical package categories this package falls under. (Please check one or more appropriate boxes below):
Data Lifecycle Packages
Explain how and why the package falls under these categories (briefly, 1-2 sentences). Please note any areas you are unsure of:
trudwraps the NHS TRUD API, which enables account holders to automate the download of technology reference files from NHS England.The technology reference files from NHS England are widely used by researchers (both within and outside the UK) working with electronic health records data. The available items include various clinical coding terminologies such as ICD, Read, prescription codes and the SNOMED CT ontology (which is updated with new available releases every few months). While
trudis a relatively small package, it provides a helpful aid to researchers working with these release items, greatly simplifying the process of automated updates to support downstream analyses.There are no other similar R packages that I am aware of.
Not applicable
@tagthe editor you contacted.#689
pkgcheckitems which your package is unable to pass.Please note that all pkgcheck checks are passing for me locally, however the pkgcheck GitHub Actions currently hangs (being investigated at ropensci-review-tools/pkgcheck#235)
Technical checks
Confirm each of the following by checking the box.
This package:
Publication options
trud0.1.0 is available on CRAN (accepted mid-2024)Do you intend for this package to go on Bioconductor?
Do you wish to submit an Applications Article about your package to Methods in Ecology and Evolution? If so:
MEE Options
Code of conduct
The text was updated successfully, but these errors were encountered: