[Rd] documenting S4 replacement methods

From: Aaron A. King <aaron.king_at_umich.edu>
Date: Tue, 05 Jun 2007 13:30:04 -0400


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

______________________________________________ R-devel_at_r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-devel

  • application/pgp-signature attachment: stored
Received on Tue 05 Jun 2007 - 17:46:58 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 Tue 05 Jun 2007 - 23:33:51 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.