[R-pkg-devel] Understanding notes from win-builder
On 03/10/2016 3:04 PM, Roy Mendelssohn - NOAA Federal wrote:
Thanks. The tests were not taking extraordinary amounts of time (roughly 30-40s) but they were greater than 10s. I retested with all the tests commented to be not tested, but based on this I have changed it so there is one simple test for each, and will see what those times are. I will add those in my cran-comments and see what comes of it. When I check internally, there are no problems, as the downloads are much faster, and varies depending on where I do the testing.
A possibility would be to include a small number of sample pages with
your package, and offer a way to view them in a browser, or run your
functions on them. The system.file() function will give the installed
location of those files.
For example, if you put sample.html in your package in directory
inst/SamplePages, it will be installed into
<pkg>/SamplePages/sample.html in your library, and can be browsed using
browseURL(system.file("SamplePages/sample.html", package = "<pkg>"))
(with appropriate substitutions for <pkg>, of course). You probably
don't want to call browseURL() in a test, but you can
use
if (interactive()) browseURL( ... )
Duncan Murdoch
-Roy
On Oct 3, 2016, at 11:56 AM, Duncan Murdoch <murdoch.duncan at gmail.com> wrote: On 03/10/2016 1:22 PM, Hadley Wickham wrote:
On Mon, Oct 3, 2016 at 12:10 PM, Roy Mendelssohn - NOAA Federal <roy.mendelssohn at noaa.gov> wrote:
Hi All: I am working on preparing a package for submission to CRAN, so using devtools i submitted the package to win-builder. I really appreciate that this has been setup, so that hopefully any final submission will be smooth. win-builder returned three notes, and I am unclear on them in the sense of not certain what I should do to resolve them so hopefully there will be no notes on submission. The first one is:
The Title field starts with the package name. The Title field should be in title case, current version then in title case: 'xtractomatic: An R package for accessing environmental data' 'Xtractomatic: An R Package for Accessing Environmental Data'
the package name is "xtractomatic", but is the last line what is preferred in the DESCRIPTION file?
On CRAN (and in other locations), packages are listed as "package_name: package_title", which in your case would lead to: xtractomatic: xtractomatic: An R package for accessing environmental data So you need to first eliminate "xtractomatic" from the title. CRAN generally also considers "an R package" to be obvious from the context so you also need to remove that. That leaves you with "Accessing Environmental Data" and suggests you might want to be a bit more specific.
The other two notes are essentially the same:
* checking examples ...
** running examples for arch 'i386' ... [87s] NOTE
Examples with CPU or elapsed time > 10s
user system elapsed
xtracto 3.29 0.81 36.49
xtracto_3D 3.14 0.64 31.40
xtractogon 0.92 0.20 10.73
** running examples for arch 'x64' ... [104s] NOTE
Examples with CPU or elapsed time > 10s
user system elapsed
xtracto 2.83 0.64 43.68
xtracto_3D 2.58 0.72 43.60
I assume the problem here is the amount of time to run the examples. The problem is that what this package does is download data from a remote server, and times can vary a lot on the examples. Is this a show stopper when I submit to CRAN? I can try to simplify the examples to cut down on the time. Alternatively, will it help to include this in the cram-comments.md file?
You can use \donttest{} to tell CRAN to not run it as part of their
automated tests.
But do leave in some tests, so the code that actually does something with the data gets exercised, and users who may not have Internet access when they look at your examples can see something. Duncan Murdoch
********************** "The contents of this message do not reflect any position of the U.S. Government or NOAA." ********************** Roy Mendelssohn Supervisory Operations Research Analyst NOAA/NMFS Environmental Research Division Southwest Fisheries Science Center ***Note new address and phone*** 110 Shaffer Road Santa Cruz, CA 95060 Phone: (831)-420-3666 Fax: (831) 420-3980 e-mail: Roy.Mendelssohn at noaa.gov www: http://www.pfeg.noaa.gov/ "Old age and treachery will overcome youth and skill." "From those who have been given much, much will be expected" "the arc of the moral universe is long, but it bends toward justice" -MLK Jr.