[Bioc-devel] runnable examples for internal function ?
Dan Tenenbaum
dtenenba at fhcrc.org
Mon Oct 13 22:33:11 CEST 2014
----- Original Message -----
> From: "Tiphaine Martin" <tiphaine.martin at kcl.ac.uk>
> To: bioc-devel at r-project.org
> Sent: Monday, October 13, 2014 1:29:08 PM
> Subject: [Bioc-devel] runnable examples for internal function ?
>
> Hi,
>
>
> I would like to know if I need to add a runnable example for each
> function that has keyword either internal or not.
>
I don't know what you mean by this, but maybe I should.
>
> I ask that because with BiocCheck, version 1.0.2, I had a message for
> function with keyword "internal" such as "
>
> Checking exported objects have runnable examples...
> * CONSIDER: Adding runnable examples to the following man pages
> which document exported objects:"
>
If the function is exported, it must have a runnable example.
> and now, I have an error message with BiocCheck, version 1.1.18
>
> * Checking exported objects have runnable examples...
> Error in if (line == "## No test: " || insideDontTest || line == "##
> End(No test)") { :
> missing value where TRUE/FALSE needed
> Calls: <Anonymous> ... checkExportsAreDocumented ->
> doesManPageHaveRunnableExample -> removeDontTest
> Execution halted
>
Can you file an issue at https://github.com/Bioconductor/BiocCheck/issues and include the name of the package?
I will get to it as soon as I can.
Dan
>
> Regards,
>
> Tiphaine
>
>
>
> ----------------------------
> Tiphaine Martin
> PhD Research Student | King's College
> The Department of Twin Research & Genetic Epidemiology | Genetics &
> Molecular Medicine Division
> St Thomas' Hospital
> 4th Floor, Block D, South Wing
> SE1 7EH, London
> United Kingdom
>
> email : tiphaine.martin at kcl.ac.uk
> Fax: +44 (0) 207 188 6761
>
> [[alternative HTML version deleted]]
>
> _______________________________________________
> Bioc-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/bioc-devel
>
More information about the Bioc-devel
mailing list