Question: How do you run BiocCheck from a continuous integration service?
gravatar for richierocks
2.1 years ago by
richierocks10 wrote:

I'd like to know how to set up continuous integration services to run BiocCheck as well as R CMD check. I'm particularly interested in SemaphoreCI and AppVeyor; answers for Travis CI are also likely to be useful to the community.

For AppVeyor and Travis CI, I guess it involves updateing the appveyor.yml/.travis.yml config file.  Adding this line should install the biocCheck package; I'm just not quite sure how to run the check and retrieve the results:

 - install_bioc BiocCheck

The R Code for a pass is something like:

chk <- BiocCheck::BiocCheck(".")
ok <- with(chk, length(requirements) + length(recommendations) == 0)

How do I set up CI to run BiocCheck?

ADD COMMENTlink modified 3 months ago by Selin Jessa10 • written 2.1 years ago by richierocks10

I've filed issues with R-builder and R-AppVeyor to start the ball rolling.

ADD REPLYlink written 2.1 years ago by richierocks10
gravatar for Dan Tenenbaum
2.1 years ago by
Dan Tenenbaum ♦♦ 8.2k
United States
Dan Tenenbaum ♦♦ 8.2k wrote:

You get to figure it out! Unless someone else has done it before. What you suggest sounds fine. But you can also run BiocCheck from the OS command line:


it will exit with 0 if there are no REQUIREMENTS, or a non-zero exit code otherwise. 

Please report back on what you got to work, I'm sure others will be interested.

ADD COMMENTlink written 2.1 years ago by Dan Tenenbaum ♦♦ 8.2k
gravatar for Selin Jessa
3 months ago by
Selin Jessa10
McGill University
Selin Jessa10 wrote:

One solution for integrating BiocCheck with Travis CI is to run BiocCheck on Travis after a successful R CMD check. Here's what the .travis.yml looks like:

# R for travis: see documentation at

language: R
r: bioc-devel
sudo: false
warnings_are_errors: true

# BiocCheck
  - BiocCheck

  - R CMD BiocCheck --new-package --no-check-vignettes [package name]*.tar.gz

And here is a working example. Note that this method means that R CMD BiocCheck will be run, and the results will be recorded in the Travis build log, but a failed BiocCheck won't fail the build, so you will need to check the results manually.

ADD COMMENTlink modified 3 months ago • written 3 months ago by Selin Jessa10
Please log in to add an answer.


Use of this site constitutes acceptance of our User Agreement and Privacy Policy.
Powered by Biostar version 2.2.0
Traffic: 118 users visited in the last hour