[Bioc-devel] BiocCheck requires example for a function with no argument.

Martin Morgan martin.morgan at roswellpark.org
Wed May 31 18:25:18 CEST 2017


On 05/31/2017 11:29 AM, Arman Sh wrote:
> Hi every one,
> 
> BiocCheck is really annoying. My package contains three functions. Two of them are flexible with multiple argument. The third one is requires internet to check available data types and returns the result as an excel file. It’s a simple function with no argument. So there is no example for that; just usage. BiocCheck returns error for this function. I can add the function to usage and example sections of the manual page, but I’m sure it will take more than 5 minutes for R CMD check, so causing problem again. What can I do? I appreciate any kind advance.

Again with the package secrecy! It helps to mention the package to 
provide some context.

Examples can illustrate output (and their further manipulation to 
integrate with the functionality of the package).

While one would really like unit tests, examples serve as a useful way 
of testing that the code actually works.

Taking multiple minutes to create an Excel spreadsheet sounds 
problematic to me -- why an excel spreadsheet, instead of something that 
the user can compute on? Why so long to generate a static result (no 
argument --> same return value each time, right?).

Martin

> 
> regards,
> Arman
> 
> 
> 	[[alternative HTML version deleted]]
> 
> _______________________________________________
> Bioc-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/bioc-devel
> 


This email message may contain legally privileged and/or...{{dropped:2}}



More information about the Bioc-devel mailing list