[R] Please help with \usage{} for [.S3Class in Rd-Format

Prof Brian Ripley ripley at stats.ox.ac.uk
Thu Jan 22 18:38:12 CET 2004

I think you may be trying too hard.  Look at Extract.data.frame.Rd and 
Extract.factor.Rd.  I would just have an Extract.refdata.Rd.

You only need the  \methods{generic}{class} notation when you want to 
document a generic and a method, or more than one method, in the same help 
file.  And at present the Perl conversion does not cope with regexp 
characters in function names ....

On Thu, 22 Jan 2004, "Jens Oehlschlägel" wrote:

> Dear all,
> I try to submit a library to CRAN but can't overcome the last R CMD CHECK. 
> Can someone enlighten me how to put the \usage{} section for an S3-Method
> extractor defined as
> > args(get("[.refdata"))
> function (x, i = NULL, j = NULL, drop = FALSE, ref = FALSE) 
> I read the "Writing R Extensions" manual and know about
> \methods{generic}{class}, however I don't get it right. 
> Please help
> Jens

Brian D. Ripley,                  ripley at stats.ox.ac.uk
Professor of Applied Statistics,  http://www.stats.ox.ac.uk/~ripley/
University of Oxford,             Tel:  +44 1865 272861 (self)
1 South Parks Road,                     +44 1865 272866 (PA)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595

More information about the R-help mailing list