[Rd] Need to tell R CMD check that a function qr.R is not a method

Henrik Bengtsson hb at biostat.ucsf.edu
Fri Sep 7 19:18:56 CEST 2012


Would a workaround (for pleasing R CMD check) be to do:

qr.R <- function(...) UseMethod("qr.R", ...)

qr.R.qr <- function(qr, complete, pivot) {
  # No need to assert the class of 'qr' here.
  ...
}

Haven't tried it.  Method dispatching may also add unnecessary
overhead if called lots of times.

/Henrik


On Fri, Sep 7, 2012 at 9:55 AM, Uwe Ligges
<ligges at statistik.tu-dortmund.de> wrote:
>
>
> On 07.09.2012 17:05, Tim Hesterberg wrote:
>>
>> When creating a package, I would like a way to tell R that
>> a function with a period in its name is not a method.
>
>
> You can't. There are few exception for historic names (S definitions)
> hardcoded in R.
>
> Best,
> Uwe
>
>
>
>>
>> I'm writing a package now with a modified version of qr.R.
>> R CMD check gives warnings:
>>
>> * checking S3 generic/method consistency ... WARNING
>> qr:
>>    function(x, ...)
>> qr.R:
>>    function(qr, complete, pivot)
>>
>> See section ‘Generic functions and methods’ of the ‘Writing R
>> Extensions’ manual.
>>
>> * checking Rd \usage sections ... NOTE
>> S3 methods shown with full name in documentation object 'QR.Auxiliaries':
>>    ‘qr.R’
>>
>> The \usage entries for S3 methods should use the \method markup and
>> not their full name.
>> See the chapter ‘Writing R documentation files’ in the ‘Writing R
>> Extensions’ manual.
>>
>>         [[alternative HTML version deleted]]
>>
>>
>>
>> ______________________________________________
>> R-devel at r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-devel
>>
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel



More information about the R-devel mailing list