Skip to content

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

2 messages · Jens Oehlschlägel, Brian Ripley

Original
Jens Oehlschlägel
# 
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
function (x, i = NULL, j = NULL, drop = FALSE, ref = FALSE) 
NULL

I read the "Writing R Extensions" manual and know about
\methods{generic}{class}, however I don't get it right. 

Please help


Jens
Brian Ripley
# 
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: