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

[Hervé Pagès]

On 05/15/2016 11:35 PM, Richard Cotton wrote:
> 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.

OTOH you could also run 'R CMD check' with the --no-examples option to
skip all examples. Wouldn't that be a more efficient solution than
cluttering your examples with \donttest directives?

Cheers,
H.

>
>> 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.
>

-- 
Hervé Pagès

Program in Computational Biology
Division of Public Health Sciences
Fred Hutchinson Cancer Research Center
1100 Fairview Ave. N, M1-B514
P.O. Box 19024
Seattle, WA 98109-1024

E-mail: hpages at fredhutch.org
Phone:  (206) 667-5791
Fax:    (206) 667-1319