[Rd] documenting S4 replacement methods
Aaron A. King
aaron.king at umich.edu
Tue Jun 5 19:30:04 CEST 2007
I'm writing a package that uses S4 classes. I'd like to have a 'coef<-'
method for one or more of the classes. The generic is defined already (in
nlme). Defining it is no problem, but I can't seem to figure out how to
handle the documentation. In particular, I'd like a \usage entry in the .Rd
file but no variant of
\S4method{coef<-}{mif}(object, pars, ..., value)
\S4method{coef<-}{mif}(object, pars, ...) <- value
\S4method{coef}{mif}(object, pars, ...) <- value
does the job. Is there a way to have the \usage line in the .Rd file? If so,
what is the correct syntax?
Thanks in advance,
Aaron
--
Aaron A. King, Ph.D.
Ecology & Evolutionary Biology
University of Michigan
GPG Public Key: 0x6E74F51B
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
Url : https://stat.ethz.ch/pipermail/r-devel/attachments/20070605/48f63b8a/attachment.bin
More information about the R-devel
mailing list