Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

R CMD Check: Skip 'checking re-building of vignette outputs'

I build my R package using --no-build-vignettes because the vignette takes very long to run. Hence, I also want to avoid that "R CMD Check " checks for the vignette re-build.
I tried to use --no-check-vignettes. However this gets ignored (not sure if it exists at all).

Another reason to ignore my vignette is the fact that I get in trouble on Travis CI because this step exceeds 10 mins (which causes the build to abort).

Is there a way to avoid the building and checking of vignettes of an R package? (Besides setting all vignette chunks to eval = FALSE)

like image 695
pat-s Avatar asked Jan 23 '17 23:01

pat-s


People also ask

What does R CMD check do?

R CMD check automatically checks your code for common problems. It's essential if you're planning on submitting to CRAN, but it's useful even if you're not because it automatically detects many common problems that you'd otherwise discover the hard way.

How do you find R vignettes?

To see the vignette for a specific package, use the argument, browseVignettes("packagename") . Each vignette provides three things: the original source file, a readable HTML page or PDF, and a file of R code. You can read a specific vignette with vignette(x) , and see its code with edit(vignette(x)) .


1 Answers

One needs to set r_check_args: "--no-build-vignettes --ignore-vignettes" in .travis.yml to skip rebuilding of vignettes.

In RStudio --no-build-vignettes needs to go into the "build options" and and --ignore-vignettes into the "check options" in the configuration GUI in the "Build" pane.

like image 166
pat-s Avatar answered Oct 28 '22 23:10

pat-s