From sfalcon at fhcrc.org  Wed May 30 16:10:26 2007
From: sfalcon at fhcrc.org (Seth Falcon)
Date: Wed, 30 May 2007 07:10:26 -0700
Subject: [Rd] S4 assignment \alias and \usage
In-Reply-To: <465D7BB2.3050405@bank-banque-canada.ca> (Paul Gilbert's message
	of "Wed, 30 May 2007 09:27:14 -0400")
References: <465D7BB2.3050405@bank-banque-canada.ca>
Message-ID: <m2wsyqflm5.fsf@ziti.local>

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



[Rd] S4 assignment \alias and \usage
Seth Falcon