Closes #47 - Switch to admiraldev::assert_unit()

[yurovska]

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral family codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

• Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
• Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
• 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
• If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
• Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
• Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
• Address any updates needed for vignettes and/or templates
• 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)
• Build site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the Reference page.
• Address or fix all lintr warnings and errors - lintr::lint_package()
• Run R CMD check locally and address all errors and warnings - devtools::check()
• Link the issue in the Development Section on the right hand side.
• Address all merge conflicts and resolve appropriately
• Pat yourself on the back for a job well done! Much love to your accomplishment!

[github-actions]

Package	Line Rate	Health
admiralmetabolic	100%	✔
Summary	100% (149 / 149)	✔

[yurovska]

@AndersAskeland @manciniedoardo

The updated admiraldev::assert_unit() has now been merged to main, so this is to finalize the ratio functions by switching from our internal unit assertion to admiraldev's one. I'm also taking a chance to update the code as per discussion here. Thanks in advance for your review.

[manciniedoardo]

LGTM - just one minor comment from me. I tested the function and everything works as expected. Test coverage still good too. Thanks @yurovska!

@AndersAskeland feel free to review and merge when ready.

[AndersAskeland]

It is looking good!

I have one thing that I think we should discuss before merging, which is how we should handle constant variables.

For instance, as the code is now, derive_param_waisthgt() will set height as constant if we provide an argument for constant_by_vars. I fear that this might be a bit confusing, both because the documentation says "By variables for when Height is constant", and that we don't specifically state we want a constant. I actually think we should have an additional argument, where we more specifically set height as a constant. For instance, constant_height. What are your thoughts on this @yurovska ?

[yurovska]

It is looking good!

I have one thing that I think we should discuss before merging, which is how we should handle constant variables.

For instance, as the code is now, derive_param_waisthgt() will set height as constant if we provide an argument for constant_by_vars. I fear that this might be a bit confusing, both because the documentation says "By variables for when Height is constant", and that we don't specifically state we want a constant. I actually think we should have an additional argument, where we more specifically set height as a constant. For instance, constant_height. What are your thoughts on this @yurovska ?

@AndersAskeland Thanks for your comment. I personally don't find it confusing given that all other similar {admiral} functions are designed in the same way. For instance, see derive_param_bmi

[AndersAskeland]

It is looking good!
I have one thing that I think we should discuss before merging, which is how we should handle constant variables.
For instance, as the code is now, derive_param_waisthgt() will set height as constant if we provide an argument for constant_by_vars. I fear that this might be a bit confusing, both because the documentation says "By variables for when Height is constant", and that we don't specifically state we want a constant. I actually think we should have an additional argument, where we more specifically set height as a constant. For instance, constant_height. What are your thoughts on this @yurovska ?

@AndersAskeland Thanks for your comment. I personally don't find it confusing given that all other similar {admiral} functions are designed in the same way. For instance, see derive_param_bmi

In that case, I agree we should keep it consistent with admiral! Great work @yurovska !