R devel - Oct 2005 - Documenting newly created generic versions of non-generic base R functions

Hi,

Following the Writing R Extensions manual, I created a method for the
cor function. As cor is not a generic, I followed the advice of section
6.1 of the same manual and did the following:

cor <- function(x, ...) UseMethod("cor")
cor.default <- stats::cor
cor.symcoca <- function{ some code }

I used package.skeleton to create the basic set-up of my package,
containing the above functions.

Do I need to provide a .Rd file for cor and cor.default? - seeing as
cor.default is cor currently.

What is the best way to handle documenting functions produced using the
above hi-jack methodology?

Cheers

Gav
-- 
%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%
Gavin Simpson                     [T] +44 (0)20 7679 5522
ENSIS Research Fellow             [F] +44 (0)20 7679 7565
ENSIS Ltd. & ECRC                 [E] gavin.simpsonATNOSPAMucl.ac.uk
UCL Department of Geography       [W] http://www.ucl.ac.uk/~ucfagls/cv/
26 Bedford Way                    [W] http://www.ucl.ac.uk/~ucfagls/
London.  WC1H 0AP.
%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%

>>>>> "GS" == Gavin Simpson <gavin.simpson at
ucl.ac.uk>
>>>>>     on Mon, 10 Oct 2005 17:29:42 +0100 writes:
    GS> Hi,
    GS> Following the Writing R Extensions manual, I created a method for the
    GS> cor function. As cor is not a generic, I followed the advice of
section
    GS> 6.1 of the same manual and did the following:

    GS> cor <- function(x, ...) UseMethod("cor")
    GS> cor.default <- stats::cor
    GS> cor.symcoca <- function{ some code }

    GS> I used package.skeleton to create the basic set-up of my package,
    GS> containing the above functions.

    GS> Do I need to provide a .Rd file for cor and cor.default? - seeing as
    GS> cor.default is cor currently.

    GS> What is the best way to handle documenting functions produced using
the
    GS> above hi-jack methodology?

I'd probably write one help page, mainly for the "symcoca"
method, but also with

\alias{cor.default}
\alias{cor.symcoca}

and
\usage{
\method{cor}{symcoca}(..........)
}

and would mention 'cor.default' and your redifinition of cor,
also \code{\link[stats]{cor}}
in the \description{...} or \details{} and/or other appropriate
places.

Regards,
Martin