Re: [Rd] S4 assignment \alias and \usage

From: Martin Maechler <maechler_at_stat.math.ethz.ch>
Date: Wed, 30 May 2007 16:18:30 +0200

>>>>> "PaulG" == Paul Gilbert <pgilbert_at_bank-banque-canada.ca>
>>>>> on Wed, 30 May 2007 09:27:14 -0400 writes:

    PaulG> What is the Rd file alias and usage syntax for an S4 assignment method?     PaulG> I have been trying variations on

    PaulG> \alias{TSdoc<-,default-method}

Do you really have a class called "default" ????

Using "<func>.default" is an S3 concept which in S4 is replaced by defining methods for "ANY".

In Matrix, we have

\alias{dim<-,Matrix-method}

and that works fine
-- though we don't have a \usage{.} there, since this really is in Matrix-class.Rd

Martin Maechler

    PaulG> \usage{
    PaulG> \S4method{TSdoc}{default}(x) <- value

    PaulG> but so far I have not got it right according to various codoc, etc, checks.

    PaulG> Paul Gilbert



R-devel_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel Received on Wed 30 May 2007 - 14:20:46 GMT

Archive maintained by Robert King, hosted by the discipline of statistics at the University of Newcastle, Australia.
Archive generated by hypermail 2.2.0, at Wed 30 May 2007 - 17:33:47 GMT.

Mailing list information is available at https://stat.ethz.ch/mailman/listinfo/r-devel. Please read the posting guide before posting to the list.