Skip to content

[R-pkg-devel] checking CRAN incoming feasibility NOTE

4 messages · Roy Mendelssohn - NOAA Federal, Mark Sharp, Ivan Krylov

#
I getting ready to submit a package to CRAN for the first time. I have run cran_prep <- check_for_cran() using the rhub package. I understand that as a new package it will generate a NOTE. As a novice, I do not know what is to be expected within that NOTE and want to make sure the NOTEs I have received are satisfactory. I have not found an example of a minimal first submission NOTE. Below is what I am getting from the above test on rhub. I have three test environments but only two NOTEs. Do these results indicate a problem to be addressed?
For a CRAN submission we recommend that you fix all NOTEs, WARNINGs and ERRORs.
## Test environments
- R-hub windows-x86_64-devel (r-devel)
- R-hub ubuntu-gcc-release (r-release)
- R-hub fedora-clang-devel (r-devel)

## R CMD check results
? On windows-x86_64-devel (r-devel), ubuntu-gcc-release (r-release)
  checking CRAN incoming feasibility ... NOTE
  Maintainer: 'R. Mark Sharp <rmsharp at me.com>'
  
  New submission
  
  License components with restrictions and base license permitting such:
    MIT + file LICENSE
  File 'LICENSE':
    Copyright 2017-2019 R. Mark Sharp
    
    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
    
    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

? On fedora-clang-devel (r-devel)
  checking CRAN incoming feasibility ...NB: need Internet access to use CRAN incoming checks
   NOTE
  Maintainer: ?R. Mark Sharp <rmsharp at me.com>?
  
  License components with restrictions and base license permitting such:
    MIT + file LICENSE
  File 'LICENSE':
    Copyright 2017-2019 R. Mark Sharp
    
    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
    
    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 errors ? | 0 warnings ? | 2 notes ?
R. Mark Sharp, Ph.D.
Data Scientist and Biomedical Statistical Consultant
7526 Meadow Green St.
San Antonio, TX 78251
mobile: 210-218-2868
rmsharp at me.com
#
use this::use_cran_comments()

There is a place to put that it is a new submission

I would recommend also testing using:

devtools::check_win_release()
devtools::check_win_devel()

You should only have the one note that it is a new  submission.  When you submit,  you may or may not get a note that it was rejected by the automatic checker. Sit tight, someone from CRAN will see that it is a new submission.  A new submission is given a much more thorough review,  so it can take a coupe days or more for CRAN to get back to you.  You can check the status of CRAN submissions at:

https://cransays.itsalocke.com/articles/dashboard.html

HTH,

-Roy
**********************
"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 street address***
110 McAllister Way
Santa Cruz, CA 95060
Phone: (831)-420-3666
Fax: (831) 420-3980
e-mail: Roy.Mendelssohn at noaa.gov www: https://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.
#
Roy, 

Thank you for your guidance and advice.

I ran usethis::use_cran_comments() shown below.
? Setting active project to '/Users/msharp/Documents/Development/R/r_workspace/library/nprcmanager'
? Writing 'cran-comments.md'
? Adding '^cran-comments\\.md$' to '.Rbuildignore'
? Modify 'cran-comments.md?

The text of ?cran-comments.md? follows and also makes me think it was a clean inspection:
## Test environments
* local OS X install, R 3.6.1
* ubuntu 14.04 (on travis-ci), R 3.6.1
* win-builder (devel and release)

## R CMD check results

0 errors | 0 warnings | 1 note

* This is a new release.


R. Mark Sharp, Ph.D.
Data Scientist and Biomedical Statistical Consultant
7526 Meadow Green St.
San Antonio, TX 78251
mobile: 210-218-2868
rmsharp at me.com
#
On Sat, 5 Oct 2019 16:52:16 -0500
"R. Mark Sharp" <rmsharp at me.com> wrote:

            
Note that for packages licensed under MIT license, the LICENSE file
should only contain the lines:
and not the actual text of MIT license. See [*] for more info.