Closes #2247 left join relationship

sophie-gem commented 2 months ago

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.

[x] Place Closes # into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
[x] Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
[x] 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
[x] If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
[x] Review the Cheat Sheet. Make any required updates to it by editing the file inst/cheatsheet/admiral_cheatsheet.pptx and re-upload a PDF version of it to the same folder.
[x] Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
[x] Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
[x] Address any updates needed for vignettes and/or templates
[x] 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.
[x] 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.
[x] Address or fix all lintr warnings and errors - lintr::lint_package()
[x] Run R CMD check locally and address all errors and warnings - devtools::check()
[x] Link the issue in the Development Section on the right hand side.
[x] Address all merge conflicts and resolve appropriately
[x] Pat yourself on the back for a job well done! Much love to your accomplishment!

github-actions[bot] commented 2 months ago

Package	Line Rate	Health
admiral	96%	✔
Summary	96% (4798 / 4993)	✔

sophie-gem commented 2 months ago

Apologies for the many names put down as review - wasn't sure who was in the best place to look at this PR. A few notes:

Not quite sure why the links check is failing...
I have only implemented this in the derive_vars_merged() and derive_vars_transposed() as I believe these are the only ones where it may be expected. But please let me know if there are others which need this.
I have updated the create_single_dose_dataset() to error (as @bundfussr suggested) when there are duplicates in the lookup_table.

Sorry this PR comes in late! If there is anything else I need to do, please let me know.

sophie-gem commented 1 month ago

Update get_hori_data() typo.

bundfussr commented 1 month ago

@bundfussr should we add tests checking that the relationship argument works within our functions.

Yes, some snapshot checks for the error messages would be nice.

By the way, I am off tomorrow and on Friday.

bms63 commented 1 month ago

@bundfussr should we add tests checking that the relationship argument works within our functions.

Yes, some snapshot checks for the error messages would be nice.

By the way, I am off tomorrow and on Friday.

@sophie-gem can you also implement a few simple tests for the relationship arguments just so we know they work/don't work

sophie-gem commented 1 month ago

@sophie-gem Thank you so much! Can you make these updates for the error messaging requested by Stefan? Hoping to finish everything up by Friday. :)

Will try and have it in place by morning US time tomorrow (so around lunchtime-ish UK time).

sophie-gem commented 1 month ago

@sophie-gem Thank you so much! Can you make these updates for the error messaging requested by Stefan? Hoping to finish everything up by Friday. :)

@bundfussr should we add tests checking that the relationship argument works within our functions.

Updated the error messaging. Learnt a lot doing this!

sophie-gem commented 1 month ago

@sophie-gem can you also implement a few simple tests for the relationship arguments just so we know they work/don't work

Hi @bms63, apologies but I don't think I'm going to have the time to implement tests also. I'm not an expert in snapshot testing and so would need more time to research into this and then also come up with some dummy examples that work.

If you don't want to make this available without tests and no-one else has the capacity, I am happy to work on this after release and leave this PR til the next release (not ideal, I know). Apologies again!

bms63 commented 1 month ago

@sophie-gem can you also implement a few simple tests for the relationship arguments just so we know they work/don't work

Hi @bms63, apologies but I don't think I'm going to have the time to implement tests also. I'm not an expert in snapshot testing and so would need more time to research into this and then also come up with some dummy examples that work.

If you don't want to make this available without tests and no-one else has the capacity, I am happy to work on this after release and leave this PR til the next release (not ideal, I know). Apologies again!

All good Sophie - I can try and make some additional tests. Is everything else ready to go? All @bundfussr comments have been addressed?

sophie-gem commented 1 month ago

@sophie-gem can you also implement a few simple tests for the relationship arguments just so we know they work/don't work

Hi @bms63, apologies but I don't think I'm going to have the time to implement tests also. I'm not an expert in snapshot testing and so would need more time to research into this and then also come up with some dummy examples that work. If you don't want to make this available without tests and no-one else has the capacity, I am happy to work on this after release and leave this PR til the next release (not ideal, I know). Apologies again!

All good Sophie - I can try and make some additional tests. Is everything else ready to go? All @bundfussr comments have been addressed?

I believe so. Went through and double checked.

bms63 commented 1 month ago

@sophie-gem I added a few snapshots tests in - they make testing a lot simpler. Do check it out when you have the time.

bms63 commented 1 month ago

I got a couple of tests in - but ran out of time and of low quality. We can write new tests for 1.2.0 as this caused us to dip from 98% to 97%...a catastrophe!! J/K! But has given me pause to think about some other testing ideas - https://github.com/pharmaverse/admiral/discussions/2453

pharmaverse / admiral

Closes #2247 left join relationship #2433