Closes #2532 Update Forumula for Body Surface Area

[jimrothstein]

…dvs_params.R)

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 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?
• Review the Cheat Sheet. Make any required updates to it by editing the file inst/cheatsheet/admiral_cheatsheet.pptx and re-upload a PDF and a PNG version of it to the same folder. (The PNG version can be created by taking a screenshot of the PDF version.)
• 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 (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). A Developer Notes section is available in NEWS.md for tracking developer-facing issues.
• Build admiral 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
admiral	97%	✔
Summary	97% (4939 / 5101)	✔

[jimrothstein]

Noticed use of else if structures, which is fine.
Any thought to switch instead; code often easier to read:

s <- function(h,w, type) {
  switch(type,
         "method a" = h+w,
         "method b" = h-w
    )
}

h=1
w=2

s(h,w, "method a")  #3
s(h,w, "method b")  # -1

[bms63]

@jimrothstein could me a entry in our news.md on this update please?

[bms63]

Noticed use of else if structures, which is fine. Any thought to switch instead; code often easier to read:

s <- function(h,w, type) {
  switch(type,
         "method a" = h+w,
         "method b" = h-w
    )
}

h=1
w=2

s(h,w, "method a")  #3
s(h,w, "method b")  # -1

switch is great - if you think it would make the code more readable lets make a new issue and discuss!! There is also an effort in all our date/time functions to make things more readable and less ifffy as we have some crazy cyclocamtic complexity going on there.

I would just stay focus on this minor documentation update for this PR and get this merged in.

[bundfussr]

This comment should be removed now.

[bundfussr]

The wording could confuse users because they may assume that the results are different now.

Either we should state that the results are still the same or we shouldn't add a NEWS entry because the change is not user-facing.

@bms63 , what do you think?

[bms63]

I think if no change for the user then lets suppress it from user-facing notes.

@jimrothstein lets move it to developer notes just so we remember when we updated - for posterity!

[jimrothstein]

The revised DuBois-DuBois forumula uses meters and not cm. The sample datasets still have cm units and I need to manually change.

[bundfussr]

The revised DuBois-DuBois forumula uses meters and not cm. The sample datasets still have cm units and I need to manually change.

I don't think so. According to https://en.wikipedia.org/wiki/Body_surface_area#Calculation the formulas expect height in cm.
Using height in m doesn't look correct to me:

> height <- 170
> weight <- 75
> 0.007184 * height^0.725 * weight^0.425
[1] 1.863558
> height <- 1.70
> 0.007184 * height^0.725 * weight^0.425
[1] 0.06612152

[bundfussr]

Height is still expected in cm. Please undo this change here and below.

[jimrothstein]

Height is still expected in cm. Please undo this change here and below.
@bundfussr - my error! Will undo and correct (to cm)