Re: [Rd] Help for methods

From: hadley wickham <>
Date: Sat 30 Sep 2006 - 05:17:39 GMT

> Yes, I agree that the current help system doesn't work very well on S3
> methods. But I don't know how to fix it. I think the only way it could
> know what to do on a construction like
> ?summary(lm(...))
> would be to actually evaluate summary(lm(...)) (or maybe just lm(...)),
> and I think that would be a huge mistake in the user interface. Some
> functions have side effects, and you don't want to evaluate them unless
> the user asks you to. Asking for help on something should give you
> help, it shouldn't do the thing.

I keep flipping back and forth on whether or not that's a problem. I agree that it's not desirable, but may be an ok compromise in principle. How does the S4 help search work?

> Do you have an actual suggestion for a change to the current behaviour?

One obvious heuristic (which I used with the hints function I wrote a while back) is to iterate through the classes of the first argument looking for functions (with documentation) of the form generic.class1, generic.class2 etc.

Obviously this will fail for functions that don't dispatch on the first method, but there probably aren't that many.

Hadley mailing list Received on Sat Sep 30 15:19:21 2006

Archive maintained by Robert King, hosted by the discipline of statistics at the University of Newcastle, Australia.
Archive generated by hypermail 2.1.8, at Sat 30 Sep 2006 - 13:30:10 GMT.

Mailing list information is available at Please read the posting guide before posting to the list.