>>>>> "GS" == Gavin Simpson <[EMAIL PROTECTED]>
>>>>> 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
______________________________________________
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
