search

Merck / simtrial

Clinical trial simulation for time-to-event endpoints
https://merck.github.io/simtrial/
GNU General Public License v3.0
18 stars 8 forks source link

Fix some NOTEs from R CMD check #200

Closed jdblischak closed 8 months ago

jdblischak commented 8 months ago

I fixed the 3 current NOTEs from R CMD check. Below is the output from when I ran it locally. They are also viewable from the the most recent build log.

── R CMD check results ───────────────────────────────── simtrial 0.3.2.3 ────
Duration: 2m 41.1s

❯ checking R code for possible problems ... NOTE
  wlr: no visible binding for global variable 'v'
  wlr: no visible binding for global variable 'z'
  Undefined global functions or variables:
    v z

❯ checking Rd line widths ... NOTE
  Rd file 'sim_gs_n.Rd':
    \examples lines wider than 100 characters:
       # - At least 20 months have elapsed after enrolling 200/400 subjects, with a minimum of 20 months follow-up

  These lines will be truncated in the PDF manual.

❯ checking for unstated dependencies in vignettes ... NOTE
  'library' or 'require' call not declared from: 'gt'

0 errors ✔ | 0 warnings ✔ | 3 notes ✖

R CMD check succeeded
jdblischak commented 8 months ago

We should keep an eye on the build status regularly, otherwise, it will become more difficult to fix after all the minor issues accumulate.

If it becomes a concern, we can configure error_on to fail if R CMD check produces a NOTE. This would make our check much more stringent, but it would also prevent these NOTEs from accumulating.

https://github.com/r-lib/actions/tree/v2-branch/check-r-package#usage

nanxstats commented 8 months ago

We should keep an eye on the build status regularly, otherwise, it will become more difficult to fix after all the minor issues accumulate.

If it becomes a concern, we can configure error_on to fail if R CMD check produces a NOTE. This would make our check much more stringent, but it would also prevent these NOTEs from accumulating.

https://github.com/r-lib/actions/tree/v2-branch/check-r-package#usage

Solid advice! 👍 At the moment, we can keep the default behavior. Given how frequently using tidy evaluation creates those "no visible binding for global variable" notes, things could derail from "stringent" to "annoying" quickly... 😂 If we release frequently enough, the check notes situation should be generally manageable.