CDCgov / ww-inference-model

An in-development R package and a Bayesian hierarchical model jointly fitting multiple "local" wastewater data streams and "global" case count data to produce nowcasts and forecasts of both observations
https://cdcgov.github.io/ww-inference-model/
Apache License 2.0
17 stars 2 forks source link

Update r-cmd-check.yaml #78

Closed dylanhmorris closed 3 months ago

dylanhmorris commented 3 months ago

Since the mandatory website build CI will fail if vignettes cannot be built, we do not need to check them in the R CMD check action as well.

dylanhmorris commented 3 months ago

This goes a long way toward resolving the problems discussed in #23, at least with R CMD check in CI. Whether we want to try to speed up website builds is another question.

dylanhmorris commented 3 months ago

What do --no-manual and --as-cran ? mean and where did you go (am guessing the github repo for actions/check-r-package ?) to figure out which commands to put in build_args / args?

  1. --no-manual and --as-cran are in there because they are the defaults for the action, so we were silently doing them before. I found that out by going to the action's github repo, as you guessed https://github.com/r-lib/actions/tree/v2-branch/check-r-package
  2. if you are interested in what each flag does and what flags are available, a useful thing to do is R CMD build --help and R CMD check --help at the command line. It was by doing this that I worked out no-vignettes for the flag I wanted for check
  3. But also some trial and error was important. For example, I first tried just setting the args for the action, but on watching the action run, I saw that that was not affecting the build step. I then noticed that there was a build_args option in the documentation, and used R CMD build --help to work out which flag to use.