closes #35 closes #31 advs vignette #53
Conversation
… reference file intervals
…call this twice
Merge branch 'main' into 35_advs_vignette # Conflicts: # _pkgdown.yml
|
rossfarrugia
changed the title
|
@zdz2101 i noticed that nowhere in the function documentation or the vignette do we explain the formulae used for Z-score and percentile derivations. do you think this should be explained in the function roxygen2 header sections? or we're only going to get this question from users. |
I'll add it to the documentation using this branch, perhaps we should include it in the vignette as well |
yes i was wondering that too, but then i added a reference to the 2 functions used, so my hope was any user would click those links and then read direct from the function pages. but yeh when you come back to review this vignette then see if you think worth to also add something here. |
|
@Fanny-Gautier once you're happy with this one i'm happy to merge! |
vignettes/advs.Rmd
Outdated
| ), | ||
| AGE = AGE * 30.4375 | ||
| )) %>% | ||
| # AGEU is added in metadata, required for derive_params_growth_age |
There was a problem hiding this comment.
Can we add the brackets in the comment for the corresponding function derive_params_growth_age() ?
There was a problem hiding this comment.
sure, will do
vignettes/advs.Rmd
Outdated
| arrange(AGE, SEX) | ||
| ``` | ||
|
|
||
| Here is how the combined metadata now looks for the age ranges around 2 |
There was a problem hiding this comment.
combined metadata for BMI ? at line 136 we are suddenly talking about HDC
There was a problem hiding this comment.
will try to explain this better to make it clearer 👍
vignettes/advs.Rmd
Outdated
| BMI percentiles and z-scores above the 95th percentile, and P95 represents this | ||
| sex and age-specific 95th percentile. | ||
|
|
||
| Note that the head circumference metadata comes only from the WHO standards, |
There was a problem hiding this comment.
it's confusing me as we were talking about BMI metadata as an example in this section
vignettes/advs.Rmd
Outdated
| Now we get to the most important section where we show how to create the | ||
| new records for each derived pediatrics parameter. Only certain examples | ||
| are included here, but you'll find more parameters in the example | ||
| template script. |
There was a problem hiding this comment.
Can you provide the link or set the shortcut to that section?
There was a problem hiding this comment.
ok, will add referenced at the bottom of this vignette rather than a link, as people should always use use_ad_template() to get this.
rossfarrugia
changed the title
|
@Fanny-Gautier replies and updates made for your review comments - thanks for these! could you take another look today please and if you're happy then we could merge this one. |
NOTE the main part of this PR is to add the new ADVS vignette, but I also added the Get Started guide, updated the logo favicons and made a few other minor tweaks from what we started with from the default admiraltemplate.
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
mainbranch until you have checked off each task.styler::style_file()to style R and Rmd filesdevtools::document()so all.Rdfiles in themanfolder and theNAMESPACEfile in the project root are updated appropriatelyNEWS.mdunder the header# admiralpeds (development version)if the changes pertain to a user-facing function (i.e. it has an@exporttag) or documentation aimed at users (rather than developers)pkgdown::build_site()and check that all affected examples are displayed correctly and that all new functions occur on the Reference page.lintr::lint_package()R CMD checklocally and address all errors and warnings -devtools::check()