Message-ID: <9bb74416-a29f-2234-f9c4-d43a943fe4fe@ifom.eu>
Date: 2018-02-27T11:25:59Z
From: Carmen M. Livi
Subject: [R-pkg-devel] CRAN submission spp 1.15.3. NOTE: checking S3 generic/method consistency
In-Reply-To: <13CE643A-84C1-4741-9930-FAF322993893@hms.harvard.edu>
Dear Uwe Ligges,
after submitting our package to CRAN we are getting the following NOTE:
===
* checking S3 generic/method consistency ... NOTE
Found the following apparent S3 methods exported but not registered:
?points.within
See section 'Registering S3 methods' in the 'Writing R Extensions'
manual.
===
"points.within" is not a S3 method. It is a function defined in the
package.
The package is already widely used in the scientific community.
Therefore renaming the function is not an option as it would cause a lot
of problems to the users.
But I saw that there are several packages available on CRAN that contain
NOTES reporting the same issue. For example:
https://www.r-project.org/nosvn/R.check/r-devel-linux-x86_64-debian-clang/pROC-00check.html
Do you have an advice on how I can address this problem? Would it be
possible to still proceed with the submission as we are not getting
errors nor warnings?
Kind regards,
Carmen
>> Thanks, we see:
>>
>>
>> * checking top-level files ... NOTE
>> Non-standard file/directory found at top level:
>> ?'aclocal.m4'
>>
>>
>> * checking S3 generic/method consistency ... NOTE
>> Found the following apparent S3 methods exported but not registered:
>> ?points.within
>> See section 'Registering S3 methods' in the 'Writing R Extensions'
>> manual.
>>
>>
>> * checking Rd \usage sections ... NOTE
>> S3 methods shown with full name in documentation object 'points.within':
>> ?'points.within'
>>
>> The \usage entries for S3 methods should use the \method markup and not
>> their full name.
>> See chapter 'Writing R documentation files' in the 'Writing R
>> Extensions' manual.
>>
>>
>> Is there some reference about the method you can add in the
>> Description field in the form Authors (year) <doi:.....>?
>>
>>
>> Please fix and resubmit.
>>
>> Best,
>> Uwe Ligges