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

From: Seth Falcon <sfalcon_at_fhcrc.org>
Date: Wed, 30 May 2007 07:10:26 -0700

Paul Gilbert <pgilbert_at_bank-banque-canada.ca> writes:

> What is the Rd file alias and usage syntax for an S4 assignment method?
> I have been trying variations on
>
> \alias{TSdoc<-,default-method}
>
> \usage{
> \S4method{TSdoc}{default}(x) <- value
>
> but so far I have not got it right according to various codoc, etc,
> checks.

If you have your own generic TSdoc<-, then I think you want:

\alias{TSdoc<-}
\alias{TSdoc<-,someClass,anotherClass-method}

You may not be allowed to specify usage, but I think the issue only arises when setting methods for a generic documented elsewhere.

+ seth

-- 
Seth Falcon | Computational Biology | Fred Hutchinson Cancer Research Center
http://bioconductor.org

______________________________________________
R-devel_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
Received on Wed 30 May 2007 - 14:13:29 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 - 14:34:16 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.