The example could show how to use the returned data. How it feeds into a simple downstream workflow...
On Wed, May 31, 2017 at 3:10 PM, Arman Sh <sh88.arman at gmail.com> wrote:
This is the only notification I get. It points to the function I
explained: It has no argument, lists available cancer studies and their
common types of high-throughput data. So it really doesn?t need an
argument. Besides, I can?t write anything more in example section but to
repeat the usage section.
regards,
Arman
*From: *Michael Lawrence <lawrence.michael at gene.com>
*Sent: *Wednesday, May 31, 2017 20:51
*To: *Arman Sh <sh88.arman at gmail.com>
*Cc: *Michael Lawrence <lawrence.michael at gene.com>;
bioc-devel at r-project.org
*Subject: *Re: [Bioc-devel] BiocCheck requires example for a function
withnoargument.
And nothing shows up in the list?
On Wed, May 31, 2017 at 8:47 AM, Arman Sh <sh88.arman at gmail.com> wrote:
I entered the function as usage and example, but the error continues;
luckily R CMD ended before 5 minutes.:
"At least 80% of man pages documenting exported objects must have runnable examples. The following pages do not:"
Best regards, arman
*From: *Michael Lawrence <lawrence.michael at gene.com>
*Sent: *Wednesday, May 31, 2017 20:12
*To: *Arman Sh <sh88.arman at gmail.com>
*Cc: *bioc-devel at r-project.org
*Subject: *Re: [Bioc-devel] BiocCheck requires example for a function
with noargument.
You could embed the example in \dontrun{}. Does BiocCheck detect cases
where the entire example is not run?
Btw, I'm pretty suspicious about this R function that takes no arguments
and downloads an Excel file. Seems like the file could be bundled with the
package, or internally lazily downloaded and cached with BiocFileCache.
On Wed, May 31, 2017 at 8:29 AM, Arman Sh <sh88.arman at gmail.com> 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.
regards,
Arman
[[alternative HTML version deleted]]
_______________________________________________ Bioc-devel at r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/bioc-devel