Related #2403: cli error message updates Part 1

[ddsjoberg]

There are a lot of calls to rlang::abort() that need updating. Best to tackle this in parts.

---

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 Related #2403 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)
• [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]]

Package	Line Rate	Health
admiral	98%	✔
Summary	98% (4717 / 4811)	✔

[millerg23]

Should the class argument be specified in the cli_abort() calls?

How would we name the classes, could use function name, but what if there is more than one check in the function. Would we ever use the class? I can see benefit of having class in assertion functions, so we can just check if check is triggered without checking message. But not sure we would use the class?

[bundfussr]

Should the class argument be specified in the cli_abort() calls?

How would we name the classes, could use function name, but what if there is more than one check in the function. Would we ever use the class? I can see benefit of having class in assertion functions, so we can just check if check is triggered without checking message. But not sure we would use the class?

Good questions! The use case I had in mind was where you have a company or study specific function which calls an admiral function and you want to catch the error to provide a more user-friendly error message. However, with a class you could easily catch the error but for the message you still need to parse the original message to get out what went wrong and generate the new message. We have this problem even with our assert_*() functions. In assert_terms() I had to call assert_data_frame() twice (once for checking it's a data frame and again for checking if the required variables are present) to be able to update the error message. Maybe it does not help much to set the class with our current approach.

[bundfussr]

I have added the changes suggested by @kaz462 to https://github.com/pharmaverse/admiral/pull/2417.

Should we cancel this PR as the changes are included also in https://github.com/pharmaverse/admiral/pull/2417?

[bms63]

I have added the changes suggested by @kaz462 to #2417.

Should we cancel this PR as the changes are included also in #2417?

Yes lets cancel this one - it is getting a little messy.

[bms63]

@bundfussr do you mind closing as you are close to this process