From murdoch.duncan at gmail.com  Mon Dec  5 19:48:19 2011
From: murdoch.duncan at gmail.com (Duncan Murdoch)
Date: Mon, 05 Dec 2011 13:48:19 -0500
Subject: [Rd] class extension and documentation
In-Reply-To: <1323105102.1719.37.camel@nemo>
References: <1323105102.1719.37.camel@nemo>
Message-ID: <4EDD11F3.4090908@gmail.com>

On 05/12/2011 12:11 PM, Terry Therneau wrote:
> I've added a "backsolve" method to the bdsmatrix library.
> Per the Extending manual section 7.1 I've also added the following 3
> lines along with my setMethod definitions for 2 classes.
>
> backsolve<- function(r, ...) UseMethod("backsolve")
> backsolve.default<- base:::backsolve
> formals(backsolve.default)<- c(formals(backsolve.default), alist(...
> = ))
>
> I've also added a backsolve-methods.Rd page, though since my arguments
> are identical to the default it doesn't say much.  And, after a test
> failed, added the new backsolve.default routine to my export list.
>
> Now R CMD check claims that I need Rd pages for backsolve and
> backsolve.default.  I don't think I should rewrite those.
>     How do I sidestep this  and/or
>     what other manuals should I read?

Even though your change is subtle, I'd say it's still a change 
(backsolve is now a generic, not a simple closure; it now has a 
different argument list), so I'd like to see a new man page added.    It 
would be quite reasonable to list the new interface and then refer to 
base::backsolve for the details of what the default method does.

Duncan Murdoch


> Perhaps do setMethod("backsolve", signature(r="ALL"),
>                             base:::backsolve(r, ...))
> instead?
>
> Terry Therneau
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel



[Rd] class extension and documentation
Duncan Murdoch