Closes #2571 transform_range: implement transform_range() #2587
Conversation
|
bundfussr
changed the title
There was a problem hiding this comment.
Thanks @bundfussr - no concerns about the function or its roxygen - looks good to me.
Wondering if, for completeness, you could also please add a quick mention for the function (no code required) here? This might increase chances users come across it when doing questionnaires, which is where this originally came from anyway.
R/transform_range.R
Outdated
| outside_range = "NA") { | ||
| # Function argument checks | ||
| assert_numeric_vector(source) | ||
| assert_numeric_vector(source_range) |
There was a problem hiding this comment.
Would be nice here to also check if source_range and target_range are of length 2, but it seems assert_numeric_vector() doesn't have an optional length argument. I think that would be nice to add though. What do you think? Too much?
There was a problem hiding this comment.
Yes, I've enhanced assert_numeric_vector() in admiraldev (see pharmaverse/admiraldev#473) and updated the calls here.
Yes, good idea! I've added a reference in the vignette. |
vignettes/questionnaires.Rmd
Outdated
| @@ -123,7 +123,8 @@ Depending on the question, `QSORRES == "YES"` is mapped to `QSSTRESN = 0` or | |||
| `QSSTRESN = 1`. If the `QSSTRESN` values are not ready to be used for deriving | |||
| scores and require transformation, it is recommended that `QSSTRESN` is kept in | |||
| the ADaM dataset for traceability, and the transformed value is stored in | |||
| `AVAL`, since that's what will be used for the score calculation. | |||
| `AVAL`, since that's what will be used for the score calculation. The | |||
There was a problem hiding this comment.
Sorry I've changed my opinion slightly - on review, I think this line would sound better in its own little section, maybe "Transformed Items"? Below "Original Items" but before "Scales and Scores" - then you could mention that sometimes questionnaire items get transformed to a different scale (e.g. 0-100) and the admiral function transformed_scale() exists for that. But this is not relevant for GAD-7.
There was a problem hiding this comment.
OK, I've added a "Transformed Items" section.
|
Thanks @bundfussr !! |
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 filesinst/cheatsheet/admiral_cheatsheet.pptxand 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.)devtools::document()so all.Rdfiles in themanfolder and theNAMESPACEfile in the project root are updated appropriatelyNEWS.mdunder the header# admiral (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). A Developer Notes section is available inNEWS.mdfor tracking developer-facing issues.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()