Closes #31 wrapper functions for waist/hip and waist/height ratio #33
Task list completed / task-list-completed
succeeded
Nov 1, 2024 in 0s
14 / 14 tasks completed
All tasks have been completed
Details
Required Tasks
| Task | Status |
|---|---|
| Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update) | Completed |
Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files |
Completed |
| Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide | Completed |
| If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance? | Completed |
| Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family. | Completed |
Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately |
Completed |
| Address any updates needed for vignettes and/or templates | Completed |
Update NEWS.md under the header # admiral<ext> (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers) |
Completed |
Build site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the Reference page. |
Completed |
Address or fix all lintr warnings and errors - lintr::lint_package() |
Completed |
Run R CMD check locally and address all errors and warnings - devtools::check() |
Completed |
| Link the issue in the Development Section on the right hand side. | Completed |
| Address all merge conflicts and resolve appropriately | Completed |
| Pat yourself on the back for a job well done! Much love to your accomplishment! | Completed |
| Sure, will remove the dummy function. | Incomplete |
The functions do appear on the reference page. Checked via devtools::build_site(). As for tidying up, I only updated the section related to the scope of this PR. If it requires changes in general, I think it should be a separate Issue. |
Incomplete |
I actually tried to add unit tests for derive_param_ratio but R CMD check failed because testthat was not able to find a function, which is not exported. Perhaps, internal functions do not require testing since it's covered by unit tests of the exported functions that use the internal ones, so it won't affect the overall test coverage rate. Please let me know if you think otherwise. |
Incomplete |
please take this opportunity to remove hello_admiral() and related tests/documentation as we now have a real function. |
Incomplete |
| please ensure the functions appear on the reference page and take the opportunity to tidy up the reference page if you can - happy to help on this front if needed. | Incomplete |
| add tests for the ratio function too, otherwise the test coverage for the package will be low. | Incomplete |
Loading