[R] S4 documentation - Was: "exact Wilcoxon signed rank test "

From: Dieter Menne <dieter.menne_at_menne-biomed.de>
Date: Mon 28 Aug 2006 - 02:46:47 EST

Torsten Hothorn <Torsten.Hothorn <at> rzmail.uni-erlangen.de> writes:

...
> indeed, this is the only gap to be filled in `coin', I just haven't had
> the time to implement this. And of course, `exactRankTests' is still
> available and will be available in the future. So you _can_ use it!
....  

Torsten, and R-Coders,

"coin" is really a great step forward, but looking at the documentation of both "exactRankTest" and "coin" together shows one bad thing about S4 documentation:

You can't find the important things any more. (not your fault, Torsten)

The functions you are going to need are drowned in a dozen "initialize" and other stuff that is irrelevant for those who only want to use do the tests. It's similar in nlme/lme4(currently documented in matrix). Normally I just try print.xx and plot.xx. When I really have problems with some specialized versions, I look into the code, because the documentation rarely give the right answers for special cases.

Therefore, I would like to propose that S4 documentation should be conditionally made available in an condensed form. Since in C++ code one probably would mark these secondary functions as "protected", I propose a keyword "protected" in the .rd files to mark those parts that should only be included in the "full" documentation.

(For fear of being rip...ed into pieces, going off for vacation now).

Dieter Menne



R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. Received on Mon Aug 28 02:50:07 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 Mon 28 Aug 2006 - 04:22:40 EST.

Mailing list information is available at https://stat.ethz.ch/mailman/listinfo/r-help. Please read the posting guide before posting to the list.