Close Issue #2461 FIX documentation to display added LOCF records

[jimrothstein]

NOT FINISHED First attempt to fix immediate problem. Wish to review code and suggest, possibily, comments.

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!

[jimrothstein]

2461 fix should now pass tests.

I would like spend a day or so to work through R code for derive_locf_records. The idea, add missing observations, makes sense, but want to understand code details.

[bms63]

Hi @jimrothstein thanks for working on this - here is our programming strategy if you want to understand some more about our design choices. https://pharmaverse.github.io/admiraldev/dev/articles/programming_strategy.html

[jimrothstein]

@bms63 Yes, programming_strategy is excellent!

Working through it. jim

[bms63]

Hi @jimrothstein did this comment get incorporated? I just glanced, but feel like the other one got implemented. I feel @bundfussr suggestion is better solution then re-arranging the data

Also admiral convention is to try and not use :: since we use library(dplyr) at the top of the examples

[jimrothstein]

Ok!

[jimrothstein]

Just an annotation/footnote

Also admiral convention is to try and not use :: since we use library(dplyr) at the top of the examples

from programmming stategy https://pharmaverse.github.io/admiraldev/articles/programming_strategy.html

@examples: A fully self-contained example of how to use the function. Self-contained means that, if this code is executed in a new R sessionit will run without errors. That means any packages need to be loaded with library() and any datasets needed either to be created directly inside the example code or loaded using data(). If a dataset is created in the example, it should be done so using the function tribble() (specify library(dplyr) before calling this function). If other functions are called in the example, please specify library(pkg_name) then refer to the respective function fun() as opposed to the preferred pkg_name::fun() notation as specified in [Unit Test Guidance](https://pharmaverse.github.io/admiraldev/articles/unit_test_guidance.html

[manciniedoardo]

@jimrothstein sorry have you implemented those changes as suggested by @bundfussr ? Looks the same as before to me. thanks

[jimrothstein]

@manciniedoardo , @bms63 I completely misread an earlier comment, apologies. Will work on @bundfussr suggestion … get back to you.

@jimrothstein sorry have you implemented those changes as suggested by @bundfussr ? Looks the same as before to me. thanks