[Bioc-devel] \donttest and the "80% of man pages documenting exported objects must have runnable examples" rule

Richard Cotton richierocks at gmail.com
Mon May 16 08:35:04 CEST 2016

On 16 May 2016 at 09:26, Hervé Pagès <hpages at fredhutch.org> wrote:
> I notice that you're using \donttest and not \dontrun though. Are you
> saying that the time it would take to run all the examples is < 5 min
> but even that is still a burden for you as a developer when you test
> your package with 'R CMD check'?

Exactly!  As I come up to releasing code, I tend to run R CMD check a
lot, and the extra minute or two each time adds up.

> I could understand that argument and
> maybe we could run 'R CMD check' with the --run-donttest option on the
> build system. That way you could keep your examples in \donttest and
> have a fast manual 'R CMD check' when you work on your package, but all
> the examples would be checked by our build system (or by you when you
> run 'R CMD check' with --run-donttest).

That would be ideal.  Thanks.


Learning R

More information about the Bioc-devel mailing list