pharmaverse / sdtmchecks

Analysis facing checks for SDTM data
https://pharmaverse.github.io/sdtmchecks/
Apache License 2.0
20 stars 6 forks source link

Use simpler title in utils.R for diff_reports() #296

Open sarabodach opened 6 months ago

sarabodach commented 6 months ago

Shorten the longer "Create a sdtmchecks list object with column indicating whether the issue was previously seen" title

https://pharmaverse.github.io/sdtmchecks/reference/diff_reports.html

image

https://github.com/pharmaverse/sdtmchecks/blob/44f42f775635bcb4f1b1c3a7aab914868a398c88/R/utils.R#L602-L608

Earlier iteration had: @title Diff two sdtmchecks reports but that doesn't capture the RDS component and sounds like the Excel is simply converted.

sarabodach commented 6 months ago

@harriscw - does the existing title for diff_reports(): #' @title Create a sdtmchecks list object with column indicating whether the issue was previously seen work for you? I was initially thinking it was too long, but on second thought, it seems fine and does capture the scope of the function. I wanted to check in if you had any other ideas, otherwise I'll close this issue.

harriscw commented 1 week ago

@AlcJ123 we have a function called run_all_checks that creates an R list object containing results of running all the checks on given set of SDTM data. We then created a function called diff_reports() to compare the R list objects created by run_all_checks to one created earlier in time. The result is the same type of R list object, just with an addition column indicating if the issue was previously seen in the prior run.

Maybe you could branch off devel, use your mastery of the English language to wordsmith the @title section of the diff_reports() Roxygen head (see R/utils.R file), and then pull request your update?